RFR: 8342808: Javadoc should add whitespace between type parameters
Per Minborg
pminborg at openjdk.org
Thu Oct 31 17:45:29 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`
Some of the more prominent users of more-than-one-type-parameter declaration are `Map` and `Function` where the upper-case parameters have a space separator. I think all `java.util.function` constructs with more than one type parameter have spaces after the coma(s). Ultimately, it is a matter of taste but at least we should be consistent.
-------------
PR Comment: https://git.openjdk.org/jdk/pull/21759#issuecomment-2450467065
More information about the javadoc-dev
mailing list