SingingBush commented on code in PR #38:
URL: https://github.com/apache/xerces-j/pull/38#discussion_r2463887097
##########
build.xml:
##########
@@ -564,7 +570,9 @@ Authors:
doctitle='Xerces2 Implementation'
bottom='${copyright}'
additionalparam='${additional.param}'
- />
+ >
+ <arg value="-Xdoclint:none"/>
Review Comment:
Setting `-Xdoclint:none` for `javax.xml.*,org.w3c.*,org.xml.*` is reasonable
but for the packages under *org.apache.xerces* it should really be
`-Xdoclint:all` (perhaps `-Xdoclint:all -Xdoclint:-missing` is reasonable).
Also it would be preferable to set the following on the xerces code:
```
failonerror='yes'
failonwarning='yes'
```
these Javadoc issues can be resolved with minimal effort. A lot of the
errors are just invalid html in classes like EncodingMap. As for the warnings,
as long as publicly accessible methods have all params and return values
documented then it should be acceptable. Potentially _failonwarning_ could be
no as long as those things are covered
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
