Review Request: 7193710 ByteArrayOutputStream Javadoc contains unclosed <code> element

Dan Xu dan.xu at oracle.com
Tue Aug 28 17:29:46 UTC 2012


Hi David,

Thank you for reviewing my changes.

I tried using {@code } in my change, but it did not work correctly as 
the tag will be nested. And it will show "{@code charset}" in the 
generated java doc instead of "charset". And <code></code> works fine in 
the nested situation.

I also uploaded the generated ByteArrayOutputStream.htmlto the public 
java review site at, 
http://cr.openjdk.java.net/~dxu/7193710/javadoc/java/io/ByteArrayOutputStream.html. 
Thanks for your notification.

-Dan


On 08/27/2012 05:16 PM, David Holmes wrote:
> Hi Dan,
>
> On 28/08/2012 6:48 AM, Dan Xu wrote:
>> This change is to fix the java doc font issue for ByteArrayOutputStream
>> class. In current javadoc, contents change to the wrong font starting
>> from toString(String charsetName) in ByteArrayOutputStream.html, which
>> can be viewed at
>> http://docs.oracle.com/javase/7/docs/api/java/io/ByteArrayOutputStream.html. 
>>
>> The issue is caused by the unclosed <code> tag.
>>
>> The webrev is at http://cr.openjdk.java.net/~dxu/7193710/webrev/.
>
> I think the current trend is to move away from <code> etc and use 
> {@code}, but your fix is correct and in-style with the rest of the 
> file. Not sure if this is an opportunity to upgrade the file to using 
> {@code} ?
>
>> And I also generated new javadoc basing on my fix, which can be looked
>> at
>> http://act.us.oracle.com/~danxu/javadoc/java/io/ByteArrayOutputStream.html. 
>>
>
> That's not accessible to non-Oracle folk.
>
> David
>
>> Thanks!
>>
>> -Dan




More information about the core-libs-dev mailing list