Skip to content

Conversation

@calnan
Copy link
Contributor

@calnan calnan commented Dec 18, 2025

added an explanation on the support of JavaDoc like links and the automatic linking of JBS IDs


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 167

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/guide/pull/167.diff

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Dec 18, 2025

👋 Welcome back calnan! 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 18, 2025

@calnan This change now passes all automated pre-integration checks.

After integration, the commit message for the final commit will be:

cover the documentation linking options in release notes

Reviewed-by: iris

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.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@irisclark) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

@openjdk openjdk bot added the rfr label Dec 18, 2025
@mlbridge
Copy link

mlbridge bot commented Dec 18, 2025

Webrevs

@openjdk
Copy link

openjdk bot commented Dec 18, 2025

⚠️ @calnan the full name on your profile does not match the author name in this pull requests' HEAD commit. If this pull request gets integrated then the author name from this pull requests' HEAD commit will be used for the resulting commit. If you wish to push a new commit with a different author name, then please run the following commands in a local repository of your personal fork:

$ git checkout releasse-note-links
$ git commit --author='Preferred Full Name <you@example.com>' --allow-empty -m 'Update full name'
$ git push

@openjdk openjdk bot added the ready label Dec 18, 2025
**Linking to the Java documentation**

* the linking options defined in JavaDoc [MarkDown](https://openjdk.org/jeps/467#Links) are supported.
* links to the JDK tools is supported. To differentiate between `[JarSigner]` the class, and `[jarsigner]` the tool, the tool reference should be in all lowercase.
Copy link
Member

Choose a reason for hiding this comment

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

I think it would be nice if "JDK tools" was a link to the tools page. I know it's version specific, but the JDK 25 page should be good enough for a few years :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

you mean [JDK tools] should be a link to the tools page?

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

Development

Successfully merging this pull request may close these issues.

3 participants