RFR: 8296175: Output warning if generated docs contain diagnostic markers

Pavel Rappo prappo at openjdk.org
Fri Apr 26 16:42:50 UTC 2024


On Fri, 26 Apr 2024 15:14:04 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

> Please review a change to print a terminal message if the documentation generated by `HtmlDoclet` contains any diagnostic marker elements for invalid input. The message is printed after the documentation has been generated and before the error/warning count with the purpose to let the user know that the documentation is not ready to be deployed and can be consulted for locating invalid input. 
> 
> Example `javadoc` output containing the new message:
> 
> 
> ...
> Generating out/index.html...
> Generating out/help-doc.html...
> The generated documentation contains diagnostic markers for invalid input.
> 3 errors
> 1 warning

The feature is good, but I'm surprised to see it being tested in DocLintTest.java.

-------------

PR Review: https://git.openjdk.org/jdk/pull/18980#pullrequestreview-2025454237


More information about the javadoc-dev mailing list