Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8346109: Create JDK taglet for additional preview notes #23395

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

hns
Copy link
Member

@hns hns commented Jan 31, 2025

Work in progress. Adds a taglet to the JDK build system and a hidden option to the javadoc tool to allow adding preview-related notes to arbitrary elements.


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-8346109: Create JDK taglet for additional preview notes (Enhancement - P3)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 23395

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

Using diff file

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

@bridgekeeper
Copy link

bridgekeeper bot commented Jan 31, 2025

👋 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

openjdk bot commented Jan 31, 2025

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

@openjdk
Copy link

openjdk bot commented Jan 31, 2025

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

  • build
  • 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.

for (DocTree tag : tags) {
if (tag.getKind() == UNKNOWN_INLINE_TAG) {
UnknownInlineTagTree inlineTag = (UnknownInlineTagTree) tag;
String[] content = inlineTag.getContent().toString().trim().split("\\s+", 2);
Copy link
Member

Choose a reason for hiding this comment

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

Just curious, does getContent() translate nested tags like nested {@code} or {@link}? I know the inline return tag translates those.

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.

2 participants