Skip to content
This repository has been archived by the owner on Sep 2, 2022. It is now read-only.
/ jdk16 Public archive

JDK-8249633: doclint reports missing javadoc for JavaFX property methods that have a property description #71

Closed
wants to merge 4 commits into from

Conversation

jonathan-gibbons
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons commented Dec 25, 2020

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.


Progress

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed

Issue

  • JDK-8249633: doclint reports missing javadoc for JavaFX property methods that have a property description

Reviewers

Download

$ git fetch https://git.openjdk.java.net/jdk16 pull/71/head:pull/71
$ git checkout pull/71

@bridgekeeper
Copy link

bridgekeeper bot commented Dec 25, 2020

👋 Welcome back jjg! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk
Copy link

openjdk bot commented Dec 25, 2020

@jonathan-gibbons The following label will be automatically applied to this pull request:

  • javadoc

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.

@openjdk openjdk bot added the javadoc javadoc-dev@openjdk.java.net label Dec 25, 2020
@openjdk openjdk bot added the rfr Pull request is ready for review label Dec 25, 2020
@mlbridge
Copy link

mlbridge bot commented Dec 25, 2020

Webrevs

Copy link
Member

@hns hns left a 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.
Copy link
Member

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: eleme nt

@openjdk
Copy link

openjdk bot commented Jan 5, 2021

@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:

8249633: doclint reports missing javadoc for JavaFX property methods that have a property description

Reviewed-by: hannesw

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 master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Jan 5, 2021
@jonathan-gibbons
Copy link
Contributor Author

/integrate

@openjdk openjdk bot closed this Jan 6, 2021
@openjdk openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Jan 6, 2021
@openjdk
Copy link

openjdk bot commented Jan 6, 2021

@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.

@jonathan-gibbons jonathan-gibbons deleted the javafx branch January 6, 2021 19:26
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
integrated Pull request has been integrated javadoc javadoc-dev@openjdk.java.net
2 participants