lukaszspyra commented on PR #1753: URL: https://github.com/apache/logging-log4j2/pull/1753#issuecomment-1751507277
Hi @vy , Thanks for the review. 1. Fixed most remaining errors (removed links which could not be fixed due to withdrawn `sun.reflect` API, but are meaningful), except 2 links to other modules - could not find a way to make them 'clickable'. 2. [Standard Doclet](https://docs.oracle.com/en/java/javase/11/docs/specs/doc-comment-spec.html) introduced in JDK8, used for javadoc validation contains many rules, some useful, whilst some annoying. In PR, there is profile created and set to respect `all` validations excluding: - `-missing` javadoc tags - most of them are either on deprecated API, self-explanatory parameters names or due to usage of brief comments in form of javadoc (gives in total ~150 warnings, majority as @param/@return tags not included). I believe it is reasonable to ignore them. - `-html` strict semantics of HTML5 (all kinds of html tags not supported in HTML5 - e.g. align/summary in table cells, self-closing elements not allowed, empty tags). Generally gives ~100 errors, complaining a lot about tables layout options not recognized in javadoc. You can remove this exclusion and assess yourself, as was not sure about recommended approach. 3. javadoc generation attached to maven-verify phase as required in issue description -- 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]
