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.

Sign up for GitHub

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

Jump to bottom

JDK-8297802: display of @spec tags should mimic that of @see tags #11426

Closed
wants to merge 3 commits into from
Closed

JDK-8297802: display of @spec tags should mimic that of @see tags #11426

wants to merge 3 commits into from

Conversation

jonathan-gibbons
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons commented Nov 30, 2022 •
edited by openjdk bot
Loading

Please review a simple change to model the list used to display @spec tags on the list used to display @see tags.

In both cases, the list uses an inline list if the items are short and do not contain commas, or a bulleted list if they are long or contain commas.

The test is updated for the new output.

For now, new CSS styles are introduced for spec-list and spec-list-long, duplicating see-list and see-list-long. We might want to merge these into tag-list and tag-list-long, or some other suitably-named pair.

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

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 11426

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

Using diff file

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

@bridgekeeper
Copy link

bridgekeeper bot commented Nov 30, 2022

👋 Welcome back jjg! 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 Nov 30, 2022

@jonathan-gibbons 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 javadoc javadoc-dev@openjdk.org label Nov 30, 2022
@openjdk openjdk bot added the rfr Pull request is ready for review label Nov 30, 2022
@mlbridge
Copy link

mlbridge bot commented Nov 30, 2022

Webrevs

pavelrappo
pavelrappo reviewed Nov 30, 2022
View reviewed changes
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/SpecTaglet.java
}
}
return writer.specTagOutput(e, tags);
}

private record Documentation(List<? extends SpecTree> seeTrees, ExecutableElement method) { }
private record Documentation(List<? extends SpecTree> specTrees, ExecutableElement method) { }
Copy link
Member

Choose a reason for hiding this comment

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

Thanks for fixing this typo.

pavelrappo
pavelrappo approved these changes Nov 30, 2022
View reviewed changes
Copy link
Member

@pavelrappo pavelrappo left a comment

Choose a reason for hiding this comment

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

Assuming tests pass, looks good.

@openjdk
Copy link

openjdk bot commented Nov 30, 2022

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

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

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

8297802: display of @spec tags should mimic that of @see tags

Reviewed-by: prappo

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 30 new commits pushed to the master branch:

  • 1722f9c: 8290231: java/foreign/malloc/TestMixedMallocFree.java crashed in JDK19 ATR run
  • 1a2ff58: 8297736: test/jdk/java/foreign/TestMatrix.java is broken
  • 6bac332: 8297853: windows-x86 test build broken
  • 53dd214: 8297742: Combine vmTestbase/nsk/monitoring/ThreadMXBean/resetPeakThreadCount tests
  • 1323e98: 8297170: misc JCK tests fail with "FATAL ERROR in native method: JDWP Can't disable vthread end events, jvmtiError=JVMTI_ERROR_WRONG_PHASE(112)"
  • c685569: 8297731: Remove redundant check in MutableBigInteger.divide
  • dcf431d: 8287400: Make BitMap range parameter names consistent
  • a1f4db5: 8297584: G1 parallel phase event for scan heap roots is sent too often
  • be4245e: 8294924: JvmtiExport::post_exception_throw() doesn't deal well with concurrent stack processing
  • be99e84: 8296875: Generational ZGC: Refactor loom code
  • ... and 20 more: https://git.openjdk.org/jdk/compare/e2d71c0a0d654841e3e591beeaa04b44c6e6b37f...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Nov 30, 2022
@jonathan-gibbons
Copy link
Contributor Author

/integrate

@openjdk
Copy link

openjdk bot commented Dec 1, 2022

Going to push as commit 3b513a4.
Since your change was applied there have been 32 commits pushed to the master branch:

  • 4485d4e: 8297728: Cache invocation type rather than invoker in NamedFunction
  • e9d501e: 8297519: Improve expressions and modernise code in PKCS
  • 1722f9c: 8290231: java/foreign/malloc/TestMixedMallocFree.java crashed in JDK19 ATR run
  • 1a2ff58: 8297736: test/jdk/java/foreign/TestMatrix.java is broken
  • 6bac332: 8297853: windows-x86 test build broken
  • 53dd214: 8297742: Combine vmTestbase/nsk/monitoring/ThreadMXBean/resetPeakThreadCount tests
  • 1323e98: 8297170: misc JCK tests fail with "FATAL ERROR in native method: JDWP Can't disable vthread end events, jvmtiError=JVMTI_ERROR_WRONG_PHASE(112)"
  • c685569: 8297731: Remove redundant check in MutableBigInteger.divide
  • dcf431d: 8287400: Make BitMap range parameter names consistent
  • a1f4db5: 8297584: G1 parallel phase event for scan heap roots is sent too often
  • ... and 22 more: https://git.openjdk.org/jdk/compare/e2d71c0a0d654841e3e591beeaa04b44c6e6b37f...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Dec 1, 2022
@openjdk openjdk bot closed this Dec 1, 2022
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Dec 1, 2022
@openjdk
Copy link

openjdk bot commented Dec 1, 2022

@jonathan-gibbons Pushed as commit 3b513a4.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

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

@pavelrappo pavelrappo pavelrappo approved these changes

Assignees
No one assigned
Labels
integrated Pull request has been integrated javadoc javadoc-dev@openjdk.org
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jonathan-gibbons @pavelrappo