Skip to content

8383793: Explore use of note tag in JDK documentation#31023

Draft
hns wants to merge 3 commits intoopenjdk:pr/28358from
hns:note-tag-examples
Draft

8383793: Explore use of note tag in JDK documentation#31023
hns wants to merge 3 commits intoopenjdk:pr/28358from
hns:note-tag-examples

Conversation

@hns
Copy link
Copy Markdown
Member

@hns hns commented May 4, 2026

This is work in progress for applying the @note tag in Java/JDK documentation.

PR for implementation of @note tag: #28358

Generated API docs for this PR: https://cr.openjdk.org/~hannesw/javadoc-notes/api.01/



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

Integration blocker

 ⚠️ Dependency #28358 must be integrated first

Issue

  • JDK-8383793: Explore use of note tag in JDK documentation (Task - P4)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 31023

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

Using diff file

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

@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 pr/28358 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 core-libs core-libs-dev@openjdk.org compiler compiler-dev@openjdk.org labels May 4, 2026
@openjdk
Copy link
Copy Markdown

openjdk Bot commented May 4, 2026

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

  • compiler
  • core-libs

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.

@hns hns force-pushed the note-tag-examples branch from 6d7a68e to e45769e Compare May 4, 2026 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

compiler compiler-dev@openjdk.org core-libs core-libs-dev@openjdk.org

Development

Successfully merging this pull request may close these issues.

1 participant