RFR: JDK-8275273: Add missing HtmlStyle documentation

Hannes Wallnöfer hannesw at openjdk.java.net
Wed Oct 20 08:57:08 UTC 2021


On Tue, 19 Oct 2021 23:37:17 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>> Please review this simple change to add doc comments to the so far undocumented `HtmlStyle` constants. I also removed one more unused constant (memberNameLabel).
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java line 836:
> 
>> 834: 
>> 835:     /**
>> 836:      * The class af a {@code div} element containing a text block that is part of a
> 
> `s/af/of/`
> 
> `text block` sounds too much like the Java construct. Is there a better way to phrase this?  Do you need the word "text" at all?

Agreed. I think "part(s) of documentation comment(s)" is a better choice. Let me know if you have another suggestion.

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

PR: https://git.openjdk.java.net/jdk/pull/5944


More information about the javadoc-dev mailing list