<AWT Dev> [12] Review Request: 8214823 Javadoc cleanup of java.awt.desktop package

Phil Race philip.race at oracle.com
Wed Jan 30 20:15:13 UTC 2019


final is pointless on an interface method but please make sure that we 
aren't
surprised that JCK signature tests check for this.

+ * Gets the search term. The platform may optionally provide the search 
term
+ * that was used to find the files. This is for example the case on Mac OS
+ * X, Apple just calls it MacOS these days .. I don't need to see a new 
webrev to fix that. Pre-approved if you fix that and verify the 
signature tests are OK -phil.

On 12/4/18 4:42 PM, Sergey Bylokhov wrote:
> Hello.
> Please review a javadoc "weekend cleanup" in jdk 12.
>
> Bug: https://bugs.openjdk.java.net/browse/JDK-8214823
> Webrev: http://cr.openjdk.java.net/~serb/8214823/webrev.00
>
> Description of the changes:
>  - 80 column limit
>  - description of the class/method/field should be followed by dot
>  - @param, @return should not end with a dot, except a case when more 
> than one sentences are used
>  - empty line after description/before the first tag was added
>  - unnecessary empty lines were removed
>  - @param, @throws, @return should be aligned, to be more readable
>  - some text can be rephrased
>
> Also in a few places the "final" keyword was removed from the parameters
> of methods in the interfaces, because it does not make any sense.
>
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/awt-dev/attachments/20190130/38844be8/attachment.html>


More information about the awt-dev mailing list