-
CSR
-
Resolution: Unresolved
-
P3
-
None
-
behavioral
-
minimal
-
add/remove/modify command line option
-
JDK
Summary
Add a new javadoc option to control how a mismatch in moduarity in externally linked documentation is reported.
Problem
In JDK-8240169 we provided a mechanism to detect and work around mismatching external documentation provided via -link
option. When this is activated javadoc issues a warning to let the user know about the mismatch. This is a problem for users who cannot fix the problem (e.g. because they do not control the external documentation) and use the -Werror
option to report warnings as errors.
Solution
Add a new option to the javadoc tool to control how messages for mismatching external documentation is reported. Using the new option, mismatching modularity in external documentation can be either reported as warning (which remains the default behaviour) or as an informational message.
Specification
The following option is added to the javadoc tool:
--link-modularity-mismatch (warn|info)
Report external documentation with wrong modularity as either
warning or informational message. The default behaviour is to
report a warning.
The effect of the new option can be further modulated by combining it with the -Werror
option to report warnings as errors or the -quiet
option to inhibit informational output.
- csr of
-
JDK-8294353 Provide a way to disable warnings for cross-modular links
- Open