<AWT Dev> [12] Review Request: 8211833 Javadoc cleanup of java.applet package
Sergey Bylokhov
Sergey.Bylokhov at oracle.com
Tue Oct 30 00:56:17 UTC 2018
Any volunteers to review? =)
On 08/10/2018 00:16, Sergey Bylokhov wrote:
> Hello.
> Please review a javadoc "weekend cleanup" in jdk 12.
>
> Bug: https://bugs.openjdk.java.net/browse/JDK-8211833
> Webrev: http://cr.openjdk.java.net/~serb/8211833/webrev.00/
> Specdiff: http://cr.openjdk.java.net/~serb/8211833/specdiff.00/java.desktop/java/applet/package-summary.html
>
> The next rules were applied:
> - 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
> - sets of spaces in the middle of text were deleted
> - @param, @throws, @return should be aligned, to be more readable
> - unnecessary imports should be removed
> - the "true"/"false" should be wrapped in {@code } when necessary
> - the order of different tags were unified across the package
>
> The styles are the same as was applied to javax.sound.**, javax.print, java.datatransfer and javax.accessibility:
> https://bugs.openjdk.java.net/browse/JDK-8184435
> https://bugs.openjdk.java.net/browse/JDK-8043979
> https://bugs.openjdk.java.net/browse/JDK-8180889
> https://bugs.openjdk.java.net/browse/JDK-8181877
>
>
--
Best regards, Sergey.
More information about the awt-dev
mailing list