<AWT Dev> [9] Review Request: 8180889 Cleanup of javadoc in java.datatransfer module

Sergey Bylokhov sergey.bylokhov at oracle.com
Wed May 24 02:19:49 UTC 2017

Please review the fix for jdk9.

Bug: https://bugs.openjdk.java.net/browse/JDK-8180889
Webrev can be found at: http://cr.openjdk.java.net/~serb/8180889/webrev.00
Specdiff: http://cr.openjdk.java.net/~serb/8180889/specdiff.00/java/awt/datatransfer/package-summary.html

In jdk9 a lots of specifications and javadocs were updated, but it seems that java.datatransfer module was missed, because the client team cleanup only the java.desktop module. 

In this fix the only javadoc is updated and the next rules were applied:
 - <tag> should be replaced by {@tag }
 - @deprecated tag should have some text
 - 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 "null"/"true"/"false"/"this" should be wrapped in {@code } when necessary
 - the order of different tags were unified across the package

The specdiff is provided and the most visible changes are:
where the text about deprecation was moved to the @deprecated tag.

More information about the awt-dev mailing list