Summary

Add an option for the javadoc tool to report an error if warnings occur.

Problem

Many users want to keep their code free of any warnings that may have been enabled, by having a build fail when warnings have occurred.

Solution

Provide a new option -Werror with similar functionality to the equivalent option in javac.

As with javac, warnings are treated as if they are errors, and a single explicit error message will be reported if any number of warnings occur.

The javadoc tool does currently have an undocumented option -Xwerror with similar but not identical functionality. This option will be folded into the new -Werror option and eventually removed in a later release.

Although the proposed name does not follow the naming guidelines in JEP 293, there is enough precedent to justify the continued use of the proposed name.

Specification

-Werror: treat warnings as if they were errors