Please Review javadoc fixes 8026982
roger riggs
roger.riggs at oracle.com
Tue Oct 22 19:14:24 UTC 2013
Hi Lance,
ok, I will add {@code}... since that's the current style. (Not used
everywhere yet).
Roger
On 10/22/2013 3:11 PM, Lance Andersen - Oracle wrote:
> Overall, I think is this good.
>
> I think in MessageDigest
>
>
> --- old/src/share/classes/java/security/MessageDigest.java 2013-10-21 17:31:32.734881244 -0400
> +++ new/src/share/classes/java/security/MessageDigest.java 2013-10-21 17:31:32.558891607 -0400
> @@ -54,21 +54,21 @@
> *
> * <p>Implementations are free to implement the Cloneable interface.
> * Client applications can test cloneability by attempting cloning
> - * and catching the CloneNotSupportedException: <p>
> + * and catching the CloneNotSupportedException:
> *
> -* <pre>
> -* MessageDigest md = MessageDigest.getInstance("SHA");
> -*
> -* try {
> -* md.update(toChapter1);
> -* MessageDigest tc1 = md.clone();
> -* byte[] toChapter1Digest = tc1.digest();
> -* md.update(toChapter2);
> -* ...etc.
> -* } catch (CloneNotSupportedException cnse) {
> -* throw new DigestException("couldn't make digest of partial content");
> -* }
> -* </pre>
> + * <pre>
> + * MessageDigest md = MessageDigest.getInstance("SHA");
> + *
> + * try {
> + * md.update(toChapter1);
> + * MessageDigest tc1 = md.clone();
> + * byte[] toChapter1Digest = tc1.digest();
> + * md.update(toChapter2);
> + * ...etc.
> + * } catch (CloneNotSupportedException cnse) {
> + * throw new DigestException("couldn't make digest of partial content");
> + * }
> + * </pre>
>
>
> The above should be in @code{} ?
> On Oct 22, 2013, at 2:53 PM, roger riggs wrote:
>
>> Please review more javadoc cleanup to satisfy javadoc -Xlint.
>> The changes remove <p> markup where it is invalid or unnecessary
>> in packages java. io, lang, net, nio, rmi, security, text, and util.
>> (this is a relatively low priority cleanup).
>>
>> Webrev:
>>
>> http://cr.openjdk.java.net/~rriggs/webrev-javadoc-8026982/
>>
>> Thanks, Roger
>>
>>
>>
>
>
> Lance Andersen| Principal Member of Technical Staff | +1.781.442.2037
> Oracle Java Engineering
> 1 Network Drive
> Burlington, MA 01803
> Lance.Andersen at oracle.com
>
More information about the core-libs-dev
mailing list