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

Sergey Bylokhov sergey.bylokhov at oracle.com
Thu May 25 01:24:25 UTC 2017

Hi, Phil. 
Thank you for a review, the fix is updated: 
Webrev can be found at: http://cr.openjdk.java.net/~serb/8180889/webrev.01 
Specdiff: http://cr.openjdk.java.net/~serb/8180889/specdiff.01/java/awt/datatransfer/package-summary.html 

Note that I have updated the text about Oracle's implementation and moved it to @implNote tag: 
So I'll file a ccc after the technical review. 

----- philip.race at oracle.com wrote: 
I don't know why it was necessary to update the non-API classes here,
and I also see some lines reformatted without any actual changes, even
white space fixes but apart from adding to noise in the change they are OK.

also this is not strictly doc since you cleaned up (not just reordered) some
import statements so I added noreg-cleanup to the bug labels.

A few nits :


104  * to Use Drag and Drop and Data Transfer</a>, section in 105  * <em>Java Tutorial</em>.

in Java Tutorial -> in the Java Tutorial 483      *         successfully loaded, then an {@code ClassNotFoundException} is

an -> a 594      * Sun's implementation for Microsoft Windows uses the encoding 595      * {@code utf-16le}. 596      * Sun's implementation for Solaris and Linux uses the encoding

Sun -> Oracle ??

And what about MacOS ? 1249      * @return {@code true} if the {@code DataFlavor} specified represents a 1250      *         List of File objects

1250 should perhaps be :
{@code java.util.List} of {@code java.io.File} objects

> On 05/23/2017 07:19 PM, Sergey Bylokhov wrote: 

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: http://cr.openjdk.java.net/~serb/8180889/specdiff.00/java/awt/datatransfer/DataFlavor-report.html#method:normalizeMimeTypeParameter(java.lang.String,%20java.lang.String) http://cr.openjdk.java.net/~serb/8180889/specdiff.00/java/awt/datatransfer/DataFlavor-report.html#method:normalizeMimeType(java.lang.String) where the text about deprecation was moved to the @deprecated tag. 
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.openjdk.java.net/pipermail/awt-dev/attachments/20170524/479d4e04/attachment-0001.html>

More information about the awt-dev mailing list