RFR: 8177100: APIs duplicated in JavaDoc [v4]

Nizar Benalla nbenalla at openjdk.org
Mon May 12 12:59:55 UTC 2025


On Mon, 12 May 2025 12:57:10 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 seven additional commits since the last revision:
> 
>  - update javadoc
>  - Merge branch 'master' into duplicate-APIs
>  - new approach - make sure there is no negative effect on JDK doc output
>  - revert VisibleMemberTable back to master
>  - fix comment
>  - simplify check
>  - merge methods from invisible supetypes

Hannes suggested in offline discussion where the check can be instead of the old approach.
I have checked that there is no change in the current JDK doc build after applying this patch.

Thanks for catching this oversight during the review.

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

PR Comment: https://git.openjdk.org/jdk/pull/25123#issuecomment-2872460059


More information about the javadoc-dev mailing list