RFR: 8253812: Cleanup AbstractMemberWriter API

Jonathan Gibbons jjg at openjdk.java.net
Tue Sep 29 16:38:27 UTC 2020


On Tue, 29 Sep 2020 16:32:00 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> This is primarily a cosmetic cleanup for the doc comments on `AbstractMemberWriter`, but cleaning up some of the
> comments leaked into fixing up comments on overridden methods as well.

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java line 330:

> 328:         List<? extends Element> members = mems;
> 329:         boolean printedUseTableHeader = false;
> 330:         if (members.size() > 0) {

The enclosing `if` statement is unnecessary.

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java line 360:

> 358:     @Override
> 359:     public void addMemberSummary(TypeElement tElement, Element member,
> 360:             List<? extends DocTree> firstSentenceTrees) {

This use of the word `tags` is a hangover from an older version of javadoc

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

PR: https://git.openjdk.java.net/jdk/pull/405


More information about the javadoc-dev mailing list