RFR [XXS] 8134356: {@code} tag contains < and > sequences
Hi! In a few places {@code } block contains < and > sequences, which are displayed verbatim in the doc. Would you please help review the trivial cleanup? BUGURL: https://bugs.openjdk.java.net/browse/JDK-8134356 WEBREV: http://cr.openjdk.java.net/~igerasim/8134356/00/webrev/ Sincerely yours, Ivan
Thanks for doing this. The code sample in SwitchPoint.java should be reformatted for consistency with other javadoc - insert " * " before every line. Did you check for & as well? The code below needs another {@code as previously in the same javadoc. + * The name {@code <init>} will be parsed into { '<', "init", '>'}} On Mon, Aug 24, 2015 at 1:30 PM, Ivan Gerasimov <ivan.gerasimov@oracle.com> wrote:
Hi!
In a few places {@code } block contains < and > sequences, which are displayed verbatim in the doc. Would you please help review the trivial cleanup?
BUGURL: https://bugs.openjdk.java.net/browse/JDK-8134356 WEBREV: http://cr.openjdk.java.net/~igerasim/8134356/00/webrev/
Sincerely yours, Ivan
Thank you Martin! On 24.08.2015 23:49, Martin Buchholz wrote:
Thanks for doing this.
The code sample in SwitchPoint.java should be reformatted for consistency with other javadoc - insert " * " before every line.
Done.
Did you check for & as well?
No &, but grep found one in java.lang.Character.java. I wasn't sure what is the way to specify it in {@code}, so just replaced it with a single space. The resulting html looks Okay.
The code below needs another {@code as previously in the same javadoc. + * The name {@code <init>} will be parsed into { '<', "init", '>'}}
Done.
On Mon, Aug 24, 2015 at 1:30 PM, Ivan Gerasimov <ivan.gerasimov@oracle.com <mailto:ivan.gerasimov@oracle.com>> wrote:
Hi!
In a few places {@code } block contains < and > sequences, which are displayed verbatim in the doc. Would you please help review the trivial cleanup?
BUGURL: https://bugs.openjdk.java.net/browse/JDK-8134356 WEBREV: http://cr.openjdk.java.net/~igerasim/8134356/00/webrev/ <http://cr.openjdk.java.net/%7Eigerasim/8134356/00/webrev/>
Sincerely yours, Ivan
Looks good! You could also get rid of the <blockquote> which is non-standard for code samples. I would have preserved the 2-space indent in the code sample, but yeah, the java standard is 4-space. On Tue, Aug 25, 2015 at 12:40 AM, Ivan Gerasimov <ivan.gerasimov@oracle.com> wrote:
Thank you Martin!
On 24.08.2015 23:49, Martin Buchholz wrote:
Thanks for doing this.
The code sample in SwitchPoint.java should be reformatted for consistency with other javadoc - insert " * " before every line.
Done.
Did you check for & as well?
No &, but grep found one in java.lang.Character.java. I wasn't sure what is the way to specify it in {@code}, so just replaced it with a single space. The resulting html looks Okay.
The code below needs another {@code as previously in the same javadoc.
+ * The name {@code <init>} will be parsed into { '<', "init", '>'}}
Done.
On Mon, Aug 24, 2015 at 1:30 PM, Ivan Gerasimov <ivan.gerasimov@oracle.com
wrote:
Hi!
In a few places {@code } block contains < and > sequences, which are displayed verbatim in the doc. Would you please help review the trivial cleanup?
BUGURL: https://bugs.openjdk.java.net/browse/JDK-8134356 WEBREV: http://cr.openjdk.java.net/~igerasim/8134356/00/webrev/
Sincerely yours, Ivan
Thanks Martin! On 25.08.2015 18:19, Martin Buchholz wrote:
Looks good! You could also get rid of the <blockquote> which is non-standard for code samples. Sure. I've also done the same with another @code block in the same file.
I would have preserved the 2-space indent in the code sample, but yeah, the java standard is 4-space.
Right. Let's keep it consistent :) Here's the final webrev: http://cr.openjdk.java.net/~igerasim/8134356/02/webrev/ Sincerely yours, Ivan
Looks good! On Tue, Aug 25, 2015 at 8:39 AM, Ivan Gerasimov <ivan.gerasimov@oracle.com> wrote:
Thanks Martin!
On 25.08.2015 18:19, Martin Buchholz wrote:
Looks good! You could also get rid of the <blockquote> which is non-standard for code samples.
Sure. I've also done the same with another @code block in the same file.
I would have preserved the 2-space indent in the code sample, but yeah,
the java standard is 4-space.
Right. Let's keep it consistent :)
Here's the final webrev: http://cr.openjdk.java.net/~igerasim/8134356/02/webrev/
Sincerely yours, Ivan
Thank you Martin for reviewing! On 24.08.2015 23:49, Martin Buchholz wrote:
Thanks for doing this.
The code sample in SwitchPoint.java should be reformatted for consistency with other javadoc - insert " * " before every line.
Done.
Did you check for & as well?
No &, but grep found one in Character. I wasn't sure how to specify in {@code}, so just replaced it with a regular space. The resulting html seems to look Okay.
The code below needs another {@code as previously in the same javadoc. + * The name {@code <init>} will be parsed into { '<', "init", '>'}}
Done. Would you please take a look at the updated webrev? http://cr.openjdk.java.net/~igerasim/8134356/01/webrev/ Sincerely yours, Ivan
participants (2)
-
Ivan Gerasimov
-
Martin Buchholz