-
Notifications
You must be signed in to change notification settings - Fork 78
JDK-8249633: doclint reports missing javadoc for JavaFX property methods that have a property description #71
Conversation
…ods that have a property description
👋 Welcome back jjg! A progress list of the required criteria for merging this PR into |
@jonathan-gibbons The following label will be automatically applied to this pull request:
When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, same two typos as in previous PR :-)
@@ -2685,35 +2687,24 @@ public TreePath getTreePath(Element e) { | |||
*/ | |||
private final Map<Element, DocCommentInfo> dcTreeCache = new LinkedHashMap<>(); | |||
|
|||
/** | |||
* Checks whether an element has an associated doc copmment. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo: copmment
/** | ||
* Checks whether an element has an associated doc copmment. | ||
* @param element the element | ||
* @return {@code true} if the eleme nt has a comment, and false otherwise |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo: eleme nt
@jonathan-gibbons This change now passes all automated pre-integration checks. ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details. After integration, the commit message for the final commit will be:
You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed. At the time when this comment was updated there had been no new commits pushed to the ➡️ To integrate this PR with the above commit message to the |
/integrate |
@jonathan-gibbons Pushed as commit 4f914e2. 💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored. |
There are two parts to the fix:
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.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.
Progress
Issue
Reviewers
Download
$ git fetch https://git.openjdk.java.net/jdk16 pull/71/head:pull/71
$ git checkout pull/71