RFR: 8263105: security-libs doclint cleanup [v3]

Roger Riggs rriggs at openjdk.java.net
Wed Mar 10 15:16:12 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

src/java.base/share/classes/java/security/AllPermission.java line 165:

> 163: 
> 164:     /**
> 165:      * true if any AllPermissions have been added

Please capitalize to make it a  sentence, and end in ".".

src/java.base/share/classes/java/security/BasicPermission.java line 261:

> 259: 
> 260:     /**
> 261:      * readObject is called to restore the state of the BasicPermission from

Please capitalize...  The readObject method...

src/java.base/share/classes/java/security/BasicPermission.java line 526:

> 524: 
> 525:     /**
> 526:      * readObject is called to restore the state of the

Ditto, capitalize.

src/java.base/share/classes/java/security/Permissions.java line 579:

> 577:     };
> 578: 
> 579:     /*

The @ serialData comment can be removed entirely. It is unused due to the "@serial exclude" above.

src/java.base/share/classes/java/security/UnresolvedPermissionCollection.java line 158:

> 156: 
> 157:     /*
> 158:      * @serialData Default field.

the comment block containing @\serialdata can be omitted entirely.

-------------

PR: https://git.openjdk.java.net/jdk/pull/2856


More information about the security-dev mailing list