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

Hannes Wallnöfer hannesw at openjdk.org
Mon Nov 18 17:51:47 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

To illustrate my previous comment, here are two screenshots of the `Spliterator.OfPrimitive` page heading:

1) in its current form without space

<img width="1237" alt="tp-no-space" src="https://github.com/user-attachments/assets/714454ff-4a95-4cc0-85a3-dd74ff5d1f0d">

2) with space added if bounds are present. 

<img width="1262" alt="tp-bounded-space" src="https://github.com/user-attachments/assets/bcfc7df0-93c8-4c3a-b720-f6f6e698e0d5">

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

PR Comment: https://git.openjdk.org/jdk/pull/21759#issuecomment-2483725164


More information about the javadoc-dev mailing list