RFR: 8177100: APIs duplicated in JavaDoc [v8]
Hannes Wallnöfer
hannesw at openjdk.org
Tue Jul 1 15:16:42 UTC 2025
On Tue, 24 Jun 2025 10:32:51 GMT, Nizar Benalla <nbenalla at openjdk.org> wrote:
>> Please review this patch to fix a bug where a method can be documented multiple times
>> Consider these 4 classes
>>
>> A (interface)
>> / \
>> / \
>> (abstract class) C B ( interface)
>> \ /
>> \ /
>> D (class)
>>
>>
>> Where `A` declares `testA()`, `C` implements it `public final void testA()`, `B` extends `A` but does *not* override it, `D` extends `C` and implements `B`
>>
>> In the generated javadoc, `testA()` is documented twice.
>>
>> 
>>
>> After the patch, `testA()` is only documented once:
>>
>> 
>
> Nizar Benalla has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains 17 additional commits since the last revision:
>
> - review feedback: add positive test
> - Merge branch 'master' into duplicate-APIs
> - Merge branch 'master' into duplicate-APIs
> - Feedback from @hns - Expand test with new test cases
> - Merge branch 'master' into duplicate-APIs
> - revert back to simple earlier fix
> - revert back to master
> - Merge branch 'master' into duplicate-APIs
> - Merge branch 'master' into duplicate-APIs
> - rename test to be more accurate and simplify code
> - ... and 7 more: https://git.openjdk.org/jdk/compare/b674cd74...00e7adcc
test/langtools/jdk/javadoc/doclet/testDuplicateMethodsWarn/TestDuplicateMethods.java line 219:
> 217: <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">V</span>()</div>
> 218: </div>
> 219: """);
That's the doc for the constructor. I was looking for method `testJ` inherited from abstract class `PubJ`.
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/25123#discussion_r2177871010
More information about the javadoc-dev
mailing list