JDK-8272374: doclint should report missing "body" comments #5106
Please review a relatively simple update to have doclnt check for empty "descriptions" -- the body of a doc comment, before the block tags.
There are three cases to consider:
No diagnostic is reported if the description is missing but the first tag is
Diagnostics are reported if the declaration is not an overriding method and does not begin with
Many of the doclint tests needed to be updated, because of their over-simplistic minimal comments. It was not possible, in general, to avoid updating the source code while preserving line numbers, so in many cases, the golden
A new test is added, focussing on the different forms of empty/missing descriptions, as described above.
The text was updated successfully, but these errors were encountered:
@jonathan-gibbons The following labels will be automatically applied to this pull request:
When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.
@jonathan-gibbons This change now passes all automated pre-integration checks.
After integration, the commit message for the final commit will be:
At the time when this comment was updated there had been 24 new commits pushed to the
As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.
Going to push as commit ae45592.
Your commit was automatically rebased without conflicts.