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

[Alexey Ivanov]

On Wed, 15 Jun 2022 17:27:53 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:
> 
>   Moved doc change.

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

> 26: package javax.swing.text.html;
> 27: 
> 28: import sun.awt.AppContext;

In JDK code, internal classes are listed below public `java.*` and `javax.*` packages. The order was correct.

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

> 1182:      * table describes what this factory will build by
> 1183:      * default.
> 1184:      * <p>

I'd rather move this block below the table. The sentence above introduces the table, then it lists how the common HTML tags are handled. This added paragraph describes how unsupported and unknown tags are handled.

Does it make sense to use lists?

* When the container is editable, …
* When the container is not editable,
  * If tag is recognized but not supported, …
  * If tag is unknown or not supported, …

Or simply split the two cases in different paragraphs for better readability?

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

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