RFR: 8342808: Javadoc should add whitespace between type parameters

Pavel Rappo prappo at openjdk.org
Thu Oct 31 16:08:28 UTC 2024


On Tue, 29 Oct 2024 11:14:54 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/TypeParams/docs/api/index.html) only includes `java.base/lang`, `java.base/util` and `java.compiler/javax`

Not all reviewers might realise it, but javadoc currently outputs generics both ways, with whitespace and without. For example, have a look at [Map.of]. The first occurrence of generic parameters (i.e. declaration), immediately after the `static` keyword, has whitespace. The second occurrence (i.e. use) does not. I think we need to make up our mind on what we should do.

[Map.of]: https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/util/Map.html#of()

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

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


More information about the javadoc-dev mailing list