RFR: 8342808: Javadoc should add whitespace between type parameters [v2]

Pavel Rappo prappo at openjdk.org
Mon Nov 18 13:12:04 UTC 2024


On Fri, 15 Nov 2024 17:25:59 GMT, Nizar Benalla <nbenalla at openjdk.org> wrote:

>> Please review this patch to render javadocs as `<K, V, T>` rather than `<K,V,T>` to match naming conventions and make the rendered output slighly nicer to read.
>> 
>> Passes langtool tests.
>> 
>> The [generated docs](https://cr.openjdk.org/~nbenalla/GeneratedDocs/K-V-space/docs/api/index.html) only include `java.base`.
>> 
>> Note for reviewers:
>> 
>> In `TestInheritence`, B is a user defined class and `TypeMirror::getKind` returns `DECLARED `. Which why we see this output. 
>> 
>> 
>> 
>> html
>> 
>> Class D<R,S>
>> java.lang.Object
>> [pkg.A](https://htmledit.squarefree.com/A.html)<S, [B](https://htmledit.squarefree.com/B.html)>
>> [pkg.B](https://htmledit.squarefree.com/B.html)<S, [B](https://htmledit.squarefree.com/B.html)>
>> pkg.D<R,S>
>
> Nizar Benalla has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains three additional commits since the last revision:
> 
>  - small improvement after getting review comments.
>    
>    Update tests
>  - Merge remote-tracking branch 'upstream/master' into javadoc-whitespace
>  - Add small whitespace before map parameters

Changes requested by prappo (Reviewer).

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlLinkFactory.java line 403:

> 401:             links.add("<");
> 402:             boolean many = false;
> 403:             boolean hasUsesOfParameterizedTypes =

I think we should name this variable better. Other than that, looks good.

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

PR Review: https://git.openjdk.org/jdk/pull/21759#pullrequestreview-2442572688
PR Review Comment: https://git.openjdk.org/jdk/pull/21759#discussion_r1846555648


More information about the javadoc-dev mailing list