RFR: JDK-8280193: summary javadoc for java.awt.GraphicsEnvironment#preferProportionalFonts broken

Alexey Ivanov aivanov at openjdk.java.net
Fri Mar 25 22:06:41 UTC 2022


On Fri, 25 Mar 2022 21:55:37 GMT, Alexey Ivanov <aivanov at openjdk.org> wrote:

> > I am fine with this but there's probably a javadoc way to escape this
> 
> Yes, there is: use an HTML entity to avoid the sequence of the period followed by a space. See the example in the [First Sentence](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#firstsentence) section in “How to Write Doc Comments for the Javadoc Tool.”
> 
> The following should work: `e.g.&#x20;` or `e.g. `. The former uses a regular space, the latter uses a non-breaking space.

The new text that uses “for example” follows another recommendation: **Avoid Latin** point under [A Style Guide](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#styleguide).

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

PR: https://git.openjdk.java.net/jdk/pull/7127



More information about the client-libs-dev mailing list