RFR: 8263105: security-libs doclint cleanup [v3]
Sean Mullan
mullan at openjdk.java.net
Wed Mar 10 19:12:09 UTC 2021
On Tue, 9 Mar 2021 22:19:28 GMT, Bradford Wetmore <wetmore at openjdk.org> wrote:
>> Fix various things pointed out by the most recent doclint run in the security-libs area.
>>
>> This is docs only: I will be checking doccheck/doclint, and will be running tier1/tier2 tests. Minor spot checks on generated files.
>
> Bradford Wetmore has updated the pull request incrementally with one additional commit since the last revision:
>
> More Codereview Comments
Marked as reviewed by mullan (Reviewer).
src/java.base/share/classes/java/security/PrivilegedActionException.java line 101:
> 99: * Serializable fields for UndeclaredThrowableException.
> 100: *
> 101: * @serialField exception Exception the undeclaredThrowable
The "undeclaredThrowable" is confusing and not defined anywhere in this class specification. Suggest changing this to:
The exception thrown by the privileged computation that resulted in this {@code PrivilegedActionException}.
src/java.base/share/classes/java/security/PrivilegedActionException.java line 99:
> 97:
> 98: /**
> 99: * Serializable fields for UndeclaredThrowableException.
The "UndeclaredThrowableException" is confusing and not defined anywhere in this class specification. Suggest changing this to:
Serializable fields for this {@code PrivilegedActionException}.
src/java.security.jgss/share/classes/javax/security/auth/kerberos/KeyImpl.java line 183:
> 181: * @serialData this {@code KeyImpl} is serialized by
> 182: * writing out the ASN1 Encoded bytes of the encryption key.
> 183: * The ASN1 encoding is defined in RFC4120 and as follows:
Nit: s/ASN1/ASN.1 (also on line 182).
src/java.security.jgss/share/classes/javax/security/auth/kerberos/KeyImpl.java line 183:
> 181: * @serialData this {@code KeyImpl} is serialized by
> 182: * writing out the ASN1 Encoded bytes of the encryption key.
> 183: * The ASN1 encoding is defined in RFC4120 and as follows:
Remove "and" and extra space after "as"
-------------
PR: https://git.openjdk.java.net/jdk/pull/2856
More information about the core-libs-dev
mailing list