[jdk16] RFR: JDK-8249633: doclint reports missing javadoc for JavaFX property methods that have a property description

Hannes Wallnöfer hannesw at openjdk.java.net
Tue Jan 5 17:07:57 UTC 2021


On Fri, 25 Dec 2020 01:56:03 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> There are two parts to the fix:
> 
> 1. Similar to that of JDK-8251200:  predicate methods in `Utils` used to check if an element has certain tags in its doc comment may trigger the missing comment check even when there does not need to be a comment.
> 
> 2. When synthesizing comments for the property-related methods, the code checks for the existence of explicit comments, in case they exist; that could also trigger the "missing comment" check.
> 
> The fix shares some changes with JDK-8251200; whichever does not go first will need a merge commit.

Looks good, same two typos as in previous PR :-)

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java line 2691:

> 2689: 
> 2690:     /**
> 2691:      * Checks whether an element has an associated doc copmment.

typo: copmment

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java line 2693:

> 2691:      * Checks whether an element has an associated doc copmment.
> 2692:      * @param element the element
> 2693:      * @return {@code true} if the eleme nt has a comment, and false otherwise

typo: eleme nt

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

Marked as reviewed by hannesw (Reviewer).

PR: https://git.openjdk.java.net/jdk16/pull/71


More information about the javadoc-dev mailing list