8341904: Search tag in inherited doc comment creates additional index item #21765
+46
−30
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.
Please review a change to avoid generation of index items for comments inherited from overridden methods. This affects
{@index}
,{@systemProperty}
, and@spec
tags in both implicitly and explicitly doc comments.The change adds two additional means for avoiding generation of index items which partially overlap:
inheritDoc
tag to the currentTagletWriter.Context
when rendering an inherited doc commentThe second check is necessary for implicitly inherited doc comments (e.g. overriding a method without doc comment), while usage of
{@inheritDoc}
tag is detected by checks. I still decided to add theinheritDoc
tag constant toTagletWriter.Context
since it is explicit, uses a mechanism that was created for the purpose, and might be useful in other places.There was a test case for the previous (buggy) behaviour to add a search tag index item using the overridden method signature as label. I changed the expected behaviour and added another method to cover usage of the
{@systemProperty}
tag in combination with{@inheritDoc}
.Progress
Issue
Reviewing
Using
git
Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/21765/head:pull/21765
$ git checkout pull/21765
Update a local copy of the PR:
$ git checkout pull/21765
$ git pull https://git.openjdk.org/jdk.git pull/21765/head
Using Skara CLI tools
Checkout this PR locally:
$ git pr checkout 21765
View PR using the GUI difftool:
$ git pr show -t 21765
Using diff file
Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/21765.diff
Webrev
Link to Webrev Comment