Javadoc omits methods in method summary

Question

I have the following interface.

interface Some {

    default <T extends Appendable> T append(final T appendable) {
    }

    default <T extends File> T append(final T file) { // Omitted form the Method Summary section
    }
}

Now, when I generate javadoc, the <T extends Appendable> T append(final T appendable) method is listed on the Method Summary section but the <T extends File> T append(final T file) method is not.

The Method Details section contains both methods.

Is this normal? How can I fix it?

rzwitserloot · Accepted Answer · 2024-01-18 03:36:23Z

4

I can reproduce the bug on JDK21's javadoc tool, so, yes. Bug reports can be filed at bugreport.java.com - unless you have a commercially supported JDK in which case you might want to file with them (and they can file with the openJDK bug repo, which only OpenJDK members can submit bug reports to).

Fixing it would involve, well, downloading the source (the javadoc tool is open source), fixing it, sending a PR somewhere, and carrying on with your fixed javadoc. That, or rename one of the methods, or write a post-processor that adds the missing HTML.

answered Jan 18, 2024 at 3:36

rzwitserloot

107k6 gold badges74 silver badges104 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Jin Kwon Over a year ago

I reported, evaluated, and assigned. FYI, bugs.java.com/bugdatabase/view_bug?bug_id=JDK-8325088

Collectives™ on Stack Overflow

Javadoc omits methods in method summary

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related