On Sat, 6 Mar 2021 19:20:39 GMT, Jonathan Gibbons <j...@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.
>
> src/java.base/share/classes/java/security/BasicPermission.java line 497:
>
>> 495: /**
>> 496: * @serialData Default fields.
>> 497: */
>
> FWIW, this doc comment will be ignored, because it will be superseded by the
> new comment on line 499. At some point doen the road, you may get a warning
> from javac about an ignored doc comment.
Ok
> src/java.base/share/classes/java/security/GuardedObject.java line 64:
>
>> 62:
>> 63: /**
>> 64: * The guard object
>
> add a period?
Probably worth doing as it's the first sentence.
> src/java.base/share/classes/java/security/PermissionCollection.java line 105:
>
>> 103: * Whether this permission collection is read-only.
>> 104: * <p>
>> 105: * If set, add() will throw an exception.
>
> maybe use `{@code}` or `{@link}` on add?
Done.
> src/java.base/share/classes/java/security/Permissions.java line 581:
>
>> 579: /**
>> 580: * @serialData Default fields.
>> 581: */
>
> Another ignored comment. I suggest just changing these to `/*` comments.
Good idea. Done.
-------------
PR: https://git.openjdk.java.net/jdk/pull/2856
