JDK-8326332: Unclosed inline tags cause misalignment in summary tables #18154
Conversation
|
👋 Welcome back hannesw! A progress list of the required criteria for merging this PR into |
Webrevs
|
|
|
||
| checkOutput("pkg/BreakIteratorTest.html", true, | ||
| """ | ||
| <div class="block">Inline tags <i><a href="../index-all.html">extending | ||
| beyond the first sentence.</a></i></div>"""); |
There was a problem hiding this comment.
I have a question:
Why doesn't it include Tags are closed here? Is it intentional or a bug?
There was a problem hiding this comment.
This piece of HTML is from the method summary table which only displays the first sentence of the doc comment (which is the root of the problem fixed by this PR).
There was a problem hiding this comment.
Got it. Thanks for your answer.
| return true; | ||
| } | ||
| // Keep track of open inline tags that need to be closed, see 8326332 | ||
| if (kind == START_ELEMENT && htmlTag.endKind == HtmlTag.EndKind.REQUIRED) { |
There was a problem hiding this comment.
Clever use of endKind -- I would not have thought of that.
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDocletWriter.java
Outdated
Show resolved
Hide resolved
|
@hns 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: 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 20 new commits pushed to the
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 |
| if (kind == Kind.START_ELEMENT) { | ||
| name = ((StartElementTree)dtree).getName(); | ||
| } else if (kind == Kind.END_ELEMENT) { | ||
| name = ((EndElementTree)dtree).getName(); | ||
| } | ||
|
|
||
| if (name != null) { | ||
| HtmlTag htmlTag = HtmlTag.get(name); |
There was a problem hiding this comment.
minor P5 suggestion to consider in future:
maybe add convenience forms for HtmlTag.of that accept a DocTree.
HtmlTree htmlTag = HtmlTree.of(tree);
HtmlTree of(DocTree dtree) {
return switch (tree.getKind()) {
case START_ELEMENT -> of(((StartElementTree)dtree).getName());
case END_ELEMENT -> of(((StartElementTree)dtree).getName());
default -> throw new IllegalArgumentException(tree.getKind().toString());
}
}
|
/integrate |
|
Going to push as commit a6dc4bc.
Your commit was automatically rebased without conflicts. |
openjdk
bot
removed
ready
Please review a simple fix to make sure inline tags are always closed in summary tables, even when the tags are closed after the first sentence in the original doc comment.
I decided to colocate the functionality to track open inline tags with the existing
ignoreNonInlineTagmethod that filters out non-inline elements because there is a lot of common functionality, such as retrieving the name and kind of an HTML tag. I considered giving the method a name that describes the additional functionality, but couldn't find one that wasn't comically long. Suggestions are welcome of course.Progress
Issue
Reviewers
Reviewing
Using
gitCheckout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/18154/head:pull/18154$ git checkout pull/18154Update a local copy of the PR:
$ git checkout pull/18154$ git pull https://git.openjdk.org/jdk.git pull/18154/headUsing Skara CLI tools
Checkout this PR locally:
$ git pr checkout 18154View PR using the GUI difftool:
$ git pr show -t 18154Using diff file
Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/18154.diff
Webrev
Link to Webrev Comment