[16] RFR: 8251182: Fix "no comment" warnings in java.naming

Roger Riggs Roger.Riggs at oracle.com
Tue Aug 25 19:17:34 UTC 2020

Hi Aleksei,

CompositeName.java readObject and writeObject methods should have a 
generic first line comment.

For example,

* The WriteObject method is called to save the state of the 
FilePermission to a stream.

* The readObject method is called to restore the state of the 
FilePermission from a stream.

There are a lot of variations in the JDK that are find, as long as they 
indicate reading or writing the
state from/to a stream.

It is conventional that javadoc tags for @param, @throws, etc. do not 
end with a period "."
unless it forms a complete sentence.

Thanks, Roger

On 8/25/20 11:03 AM, Aleks Efimov wrote:
> Hi,
> The documentation of classes from "java.naming" module needs to be 
> improved to resolve javadoc -Xdoclint "no comment" warnings.
> JBS issue: https://bugs.openjdk.java.net/browse/JDK-8251182
> Webrev: http://cr.openjdk.java.net/~aefimov/8251182/00/index.html
> CSR: https://bugs.openjdk.java.net/browse/JDK-8252310
> With Best Regards,
> Aleksei

More information about the core-libs-dev mailing list