RFR: 8012675: Javadoc for javax.swing.text.html.parser.Parser.handleComment() needs to be updated [v16]

[Alexey Ivanov]

On Thu, 16 Jun 2022 07:59:08 GMT, Damon Nguyen <dnguyen at openjdk.org> wrote:

>> Updated Parser class doc by appending to the doc regarding lack of support for HTML script tags. Adding this information to the "parse" function did not seem as consistent for formatting as adding it to the Parser class doc.
>
> Damon Nguyen has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Added list format to javadoc and moved to under table. Fixed auto import.

Changes requested by aivanov (Reviewer).

src/java.desktop/share/classes/javax/swing/text/html/HTMLEditorKit.java line 1304:

> 1302:      *
> 1303:      * <p>
> 1304:      * @implNote

The `<p>` tag before `@implNote` is unneeded, javadoc will generate a section code.

At least I can't see it used in other places. I'm currently building docs with this change to confirm.

src/java.desktop/share/classes/javax/swing/text/html/HTMLEditorKit.java line 1314:

> 1312:      *     <li>The content within the tags will be handled by the editor as
> 1313:      *     regular text.</li>
> 1314:      * </ul>

You should close `</li>` on the first line but after closing `</ul>`: the inner `<ul>` has to be inside a list item.

The list should look like:

<ul>
    <li>Outer 1st
        <ul>
            <li>Inner</li>
        </ul>
   </li>
   <li>Outer 2nd</li>
</ul>

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

PR: https://git.openjdk.org/jdk/pull/7446