8267633: Clarify documentation of (Doc)TreeScanner

[pavelrappo]

When a method is said to be called "on an object", this means that the object is a receiver. When a method is said to be called "with an object", this means that the object is a parameter.

To scan an instance of (Doc)Tree, the "scan" method is called on the instance of (Doc)TreeScanner with that instance of (Doc)Tree.

---

Progress

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

Issue

• JDK-8267633: Clarify documentation of (Doc)TreeScanner

Reviewers

• Jonathan Gibbons (@jonathan-gibbons - Reviewer) ⚠️ Review applies to 9f5ba18

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/4174/head:pull/4174
$ git checkout pull/4174

Update a local copy of the PR:
$ git checkout pull/4174
$ git pull https://git.openjdk.java.net/jdk pull/4174/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 4174

View PR using the GUI difftool:
$ git pr show -t 4174

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/4174.diff

[bridgekeeper]

👋 Welcome back prappo! 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.

[jonathan-gibbons]

OK.

I'm not entirely comfortable with the phrasing of call with but I understand the issue with call on.

[jonathan-gibbons]

Inconsistent space after <li> (Since this is mostly a cleanup PR)

[openjdk]

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

8267633: Clarify documentation of (Doc)TreeScanner

Reviewed-by: jjg

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 13 new commits pushed to the master branch:

• a52c4ed: 8267110: Update java.util to use instanceof pattern variable
• 0a03fc8: 8255674: SSLEngine class description is missing "case" in switch statement
• d86f916: 8267066: New NSAccessibility peers should return they roles and subroles directly
• 31d0f0d: 8248843: java in source-file mode suggests javac-only options
• 2e8812d: 8265129: Add intrinsic support for JVM.getClassId
• 123cdd1: 8264973: AArch64: Optimize vector max/min/add reduction of two integers with NEON pairwise instructions
• b4d4884: 8267126: javadoc should show "line and caret" for diagnostics.
• 461a3fe: 8261478: InstanceKlass::set_classpath_index does not match comments
• de27da7: 8267431: Rename InstanceKlass::has_old_class_version to can_be_verified_at_dumptime
• c519ba2: 8267614: Outline VarHandleGuards exact behavior checks
• ... and 3 more: https://git.openjdk.java.net/jdk/compare/a5467ae7bb5780f34728ad073c5c4158894c7c4b...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this 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]

@pavelrappo The following labels will be automatically applied to this pull request:

• compiler
• javadoc

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 01: Full - Incremental (27590231)
• 00: Full (9f5ba184)

[pavelrappo]

/integrate

[openjdk]

@pavelrappo Since your change was applied there have been 16 commits pushed to the master branch:

• 86a8f44: 8267317: Remove DeferredTypeCompleter
• b403d39: 8267213: cpuinfo_segv is incorrectly triaged as execution protection violation on x86_32
• 66b190e: 8267612: Declare package-private VarHandle.AccessMode/AccessType counts
• a52c4ed: 8267110: Update java.util to use instanceof pattern variable
• 0a03fc8: 8255674: SSLEngine class description is missing "case" in switch statement
• d86f916: 8267066: New NSAccessibility peers should return they roles and subroles directly
• 31d0f0d: 8248843: java in source-file mode suggests javac-only options
• 2e8812d: 8265129: Add intrinsic support for JVM.getClassId
• 123cdd1: 8264973: AArch64: Optimize vector max/min/add reduction of two integers with NEON pairwise instructions
• b4d4884: 8267126: javadoc should show "line and caret" for diagnostics.
• ... and 6 more: https://git.openjdk.java.net/jdk/compare/a5467ae7bb5780f34728ad073c5c4158894c7c4b...master

Your commit was automatically rebased without conflicts.

Pushed as commit 5a5b807.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.