On Mon, 2 Sep 2024 11:08:36 GMT, Hannes Wallnöfer <[email protected]> wrote:
>> Please review an update to "clean up" the direct use of HtmlTree
>> constructors.
>>
>> Hitherto, many/most instances of `HtmlTree` were created by static factory
>> methods. This update extends that convention.
>> In most cases, this is by providing either simple no-arg factory methods or
>> commonly used overloads that take an `HtmlId` or `HtmlStyle`.
>>
>> For some tags, (`br`, `hr`, `wbr`) this allows a singleton instance to be
>> used.
>> For some of the more obscure cases, a more generic `HtmlTree.of(HtmlTag)`
>> method was used.
>>
>> Notes:
>> * some significant block-level nodes, like `pre`, should probably always set
>> a style, which could be enforced by suitable factory methods. That is
>> currently not the case and could be a future cleanup.
>> * some lists put the same style info on each list item, but might be better
>> placed on the enclosing list. That could be a future cleanup
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/html/HtmlTree.java line
> 401:
>
>> 399: * Creates an HTML {@code BUTTON} element with the given id.
>> 400: *
>> 401: * @return the element
>
> Missing `@param` for `id`.
Given the possibility of exporting this package to other JDK modules, it might
be interesting to add a test that runs DocLint on this package.
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/20778#discussion_r1742516771
