RFR: JDK-8237597 Fix typography in comments for Doclet.Option.Kind
Jonathan Gibbons
jonathan.gibbons at oracle.com
Tue Jan 21 21:18:21 UTC 2020
Please review a tiny changeset (inline below) to fix the typography in
some short javadoc comments.
No semantic changes, so no CSR.
-- Jon
JBS: https://bugs.openjdk.java.net/browse/JDK-8237597
diff -r afedfc27878c
src/jdk.javadoc/share/classes/jdk/javadoc/doclet/Doclet.java
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/doclet/Doclet.java Tue
Jan 21 18:38:46 2020 +0000
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/doclet/Doclet.java Tue
Jan 21 13:09:24 2020 -0800
@@ -154,11 +154,11 @@
* The kind of an option.
*/
enum Kind {
- /** an extended option, such as those prefixed with -X */
+ /** An extended option, such as those prefixed with {@code
-X}. */
EXTENDED,
- /** a standard option */
+ /** A standard option. */
STANDARD,
- /** an implementation reserved option */
+ /** An implementation-reserved option. */
OTHER;
}
}
More information about the javadoc-dev
mailing list