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

8348282: Add option for syntax highlighting in javadoc snippets #24417

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

hns
Copy link
Member

@hns hns commented Apr 3, 2025

Please review a change to add a javadoc option to enable syntax highlighting for code fragments in snippets and <pre><code> tags. The new --syntax-highlight option uses the [highlight.js] JavaScript library and supports Java, Properties, XML, HTML and JSON. The option is enabled in the JDK API docs target, generated output is available here.


Progress

  • Change requires CSR request JDK-8352691 to be approved
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed (2 reviews required, with at least 2 Reviewers)

Issues

  • JDK-8348282: Add option for syntax highlighting in javadoc snippets (Enhancement - P3)
  • JDK-8352691: Add option for syntax highlighting in javadoc snippets (CSR)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 24417

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

Using diff file

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

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Apr 3, 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 Apr 3, 2025

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

@openjdk openjdk bot added the csr Pull request needs approved CSR before integration label Apr 3, 2025
@openjdk
Copy link

openjdk bot commented Apr 3, 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.

@openjdk openjdk bot added javadoc javadoc-dev@openjdk.org build build-dev@openjdk.org labels Apr 3, 2025
@openjdk openjdk bot added the rfr Pull request is ready for review label Apr 3, 2025
@mlbridge
Copy link

mlbridge bot commented Apr 3, 2025

Webrevs

Copy link
Member

@erikj79 erikj79 left a comment

Choose a reason for hiding this comment

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

Build change looks trivially good.

/reviewers 2 reviewer

@openjdk
Copy link

openjdk bot commented Apr 4, 2025

@erikj79
The total number of required reviews for this PR (including the jcheck configuration and the last /reviewers command) is now set to 2 (with at least 2 Reviewers).

@hns
Copy link
Member Author

hns commented Apr 10, 2025

Here's a selection of code fragments from the sample docs using syntax highlighting:

@openjdk openjdk bot removed the csr Pull request needs approved CSR before integration label Apr 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build build-dev@openjdk.org javadoc javadoc-dev@openjdk.org rfr Pull request is ready for review
Development

Successfully merging this pull request may close these issues.

3 participants