Fix javadoc errors that are normally masked in Maven doc runs #528
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It has grown to such size that breaking it up is long overdue anyway, but the immediate impetus was to do a trial javadoc run checking everything (--show-module-contents all --show-packages-all --show-types private --show-members private). I have no intention of changing the doc build options to build all that as a matter of course, but it ought to be possible, so a run with those settings is useful to identify and fix any javadoc-reported errors that cause the generation to fail, as opposed to mere warnings. Javadoc was immediately displeased by the multi-class compilation unit here.
... with --show-module-contents all --show-packages all --show-types private --show-members private. There are still lots of warnings reported and I have made no effort to look at the docs generated with those settings. But it ought to be possible to do so, with the first step being to eliminate the errors that cause generation to fail.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Because the Maven POMs are not requesting maximal
javadoccoverage (--show-module-contents all --show-packages all --show-types private --show-members private) in normal use, there are a lot ofjavadoc-formatted comments in the source code that are not routinely getting checked for errors, and if anyone does run a more-completejavadocreport for a special purpose, errors in those non-checked comments cause the run to fail.It is not a goal of this PR to change the coverage options passed to
javadocin the POMs for normal use, or to proofread or improve, or add where incomplete, any of those normally-masked comments, or to do anything about the numerousjavadocwarnings. The goal is simply to address the detected errors that prevent a maximaljavadocrun completing successfully.Surprisingly, perhaps, there were not very many of those. It should now be possible to do maximal
javadocruns on occasion as a development practice, to ensure new errors do not creep in.This work necessitated splitting
DDRProcessor.java, which, for historical reasons, had grown to a very large multiple-class single compilation unit. That was a problem forjavadoc, which is less able to find extra classes inside a compilation unit thanjavacis. That was the biggest part of the job.