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

[Damon Nguyen]

On Wed, 15 Jun 2022 18:19:54 GMT, Phil Race <prr at openjdk.org> wrote:

>> 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 1192:
> 
>> 1190:      * such as script tags, the tag and its contents will be hidden.
>> 1191:      * If the container is not editable and a tag is unknown or not supported at
>> 1192:      * all, the tags will be hidden but its contents will display as regular text.
> 
> "unknown or not supported at all" ?
> unknown tags are surely always unsupported so why do we need to say that here ?
> 
> With all the above it ends up something like 
>      * @implNote
>      * Parsed tags that are unrecognized or are recognized but unsupported are handled differently by the editor.
>      * <ul>
>      * <li> When the container using HTML tags is editable, all such tags
>      * The contents will be displayed as editable text fields in place of the tags.
>      * The content within the tags will be handled by the editor as regular text.
>      * <li> If the container is not editable and a tag is recognized but not supported,
>      * such as script tags, the tag and its contents will be hidden.
>      * <li> If the container is not editable and a tag is unknown
>      * the tag will be hidden but its contents will display as regular text.
>       *</ul>
>      * <p>
>      * <p>

I took @aivanov-jdk and your advice and reformatted the text into list formatting. I reworded some statements to better differentiate tag text vs contents within the tags. I hope it's clear, but let me know if there is still anything unclear.

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

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