Skip to content

8383792: Simplify internal DocFinder API#31022

Open
hns wants to merge 1 commit intoopenjdk:masterfrom
hns:JDK-8383792
Open

8383792: Simplify internal DocFinder API#31022
hns wants to merge 1 commit intoopenjdk:masterfrom
hns:JDK-8383792

Conversation

@hns
Copy link
Copy Markdown
Member

@hns hns commented May 4, 2026

Please review a change to simplify use of the internal DocFinder class. Previously, users of the class had to call the search or find method when looking up documentation in an overridden method, depending on whether an explicit orverridden source method was provided.

The find method is updated to handle both cases (which are always used together, but passing null for the src argument restores the old behavior of the find method). Additionally, find is renamed to searchInherited to make its relation the search method clearer (searchInherited searches in overridden methods only while search starts in the method itself).

The internal search0 method loses a redundant boolean parameter, the new overriddenMethodsOnly parameter is the same as not(includeMethodInSearch) and throwExceptionIfDoesNotOverride.



Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8383792: Simplify internal DocFinder API (Task - P4)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/31022/head:pull/31022
$ git checkout pull/31022

Update a local copy of the PR:
$ git checkout pull/31022
$ git pull https://git.openjdk.org/jdk.git pull/31022/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 31022

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/31022.diff

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link
Copy Markdown

bridgekeeper Bot commented May 4, 2026

👋 Welcome back hannesw! 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
Copy Markdown

openjdk Bot commented May 4, 2026

❗ This change is not yet ready to be integrated.
See the Progress checklist in the description for automated requirements.

@openjdk openjdk Bot added the javadoc javadoc-dev@openjdk.org label May 4, 2026
@openjdk
Copy link
Copy Markdown

openjdk Bot commented May 4, 2026

@hns 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 rfr Pull request is ready for review label May 4, 2026
@mlbridge
Copy link
Copy Markdown

mlbridge Bot commented May 4, 2026

Webrevs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

javadoc javadoc-dev@openjdk.org rfr Pull request is ready for review

Development

Successfully merging this pull request may close these issues.

1 participant