-
Notifications
You must be signed in to change notification settings - Fork 6.1k
8356975: Provide alternative way to generate preview API docs #26267
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
base: master
Are you sure you want to change the base?
Conversation
👋 Welcome back hannesw! A progress list of the required criteria for merging this PR into |
❗ This change is not yet ready to be integrated. |
/issue add JDK-8355933 |
@hns |
var previewDiv = HtmlTree.DIV(HtmlStyles.previewBlock); | ||
previewDiv.setId(htmlIds.forPreviewSection(forWhat)); | ||
previewDiv.add(HtmlTree.DIV(HtmlStyles.previewComment, | ||
commentTagsToContent(forWhat, tags.getFirst().getContent(), false))); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we add a check to assert there is exactly one occurrence of such a preview note tag?
Please review a change to allow marking API elements as preview features via a new hidden
--preview-feature-tag
option. In conjunction with the already existing hidden--preview-note-tag
option this allows documenting elements as preview features without relying on JDK-internal types.Part of this change is a refactoring of how
SummaryListWriter
allows its subclasses to extend the content of summary pages. The oldaddExtra*
hook methods were too unflexible as they always add extra content before other page content. I replaced them with protectedgetIndexLinks
andaddSummaries
methods that allow overriding methods to add extra content before or after the default content returned by the super method.The change also includes the fix for JDK-8355933 to change the presentation and wording for elements with preview notes as requested by the Valhalla team.
The output generated by the new test with preview features marked by tags can be viewed here.
Progress
Issues
Reviewing
Using
git
Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/26267/head:pull/26267
$ git checkout pull/26267
Update a local copy of the PR:
$ git checkout pull/26267
$ git pull https://git.openjdk.org/jdk.git pull/26267/head
Using Skara CLI tools
Checkout this PR locally:
$ git pr checkout 26267
View PR using the GUI difftool:
$ git pr show -t 26267
Using diff file
Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/26267.diff
Using Webrev
Link to Webrev Comment