RFR: 8177100: APIs duplicated in JavaDoc [v9]

Hannes Wallnöfer hannesw at openjdk.org
Fri Jul 4 12:17:32 UTC 2025


On Fri, 4 Jul 2025 12:14:28 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.
>> 
>> ![Screenshot 2025-05-08 at 15 51 19](https://github.com/user-attachments/assets/46538e61-1546-4128-8041-296d8491406f)
>> 
>> After the patch, `testA()` is only documented once:
>> 
>> ![Screenshot 2025-05-08 at 15 52 16](https://github.com/user-attachments/assets/a6b86a21-7104-460c-8f3f-36cee5962eed)
>
> 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 19 additional commits since the last revision:
> 
>  - Fix test based on feedback
>  - Merge branch 'master' into duplicate-APIs
>  - 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
>  - ... and 9 more: https://git.openjdk.org/jdk/compare/a2470982...a34c4d51

Thanks, looks good. 

And sorry for being nit-picky about the tests, but it's better to have all details covered.

-------------

Marked as reviewed by hannesw (Reviewer).

PR Review: https://git.openjdk.org/jdk/pull/25123#pullrequestreview-2986952404


More information about the javadoc-dev mailing list