RFR: 8342808: Javadoc should add whitespace between type parameters

Hannes Wallnöfer hannesw at openjdk.org
Thu Oct 31 13:53:30 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`

I'm not sure about this change. For the common case of single uppercase letter parameter names, I actually find the notation without space character more readable, and that also seems to be the convention in most OpenJDK code. 

If we are going to introduce a space character after the comma for type parameters, we also should get rid of the `<wbr>` (line break opportunity) element, as that is not needed anymore with the addes space.

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

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


More information about the javadoc-dev mailing list