RFR: JDK-8326332: Unclosed inline tags cause misalignment in summary tables

Hannes Wallnöfer hannesw at openjdk.org
Fri Mar 8 11:12:52 UTC 2024


On Fri, 8 Mar 2024 10:16:51 GMT, Guoxiong Li <gli at openjdk.org> wrote:

>> 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 `ignoreNonInlineTag` method 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.
>
> test/langtools/jdk/javadoc/doclet/testBreakIterator/TestBreakIterator.java line 83:
> 
>> 81:                 """
>> 82:                     <div class="block">Inline tags <i><a href="../index-all.html">extending
>> 83:                      beyond the first sentence.</a></i></div>""");
> 
> I have a question:
> Why doesn't it include ` Tags are closed here`? Is it intentional or a bug?

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).

-------------

PR Review Comment: https://git.openjdk.org/jdk/pull/18154#discussion_r1517580631


More information about the javadoc-dev mailing list