<Swing Dev> [9] Review Request: 8181877 Cleanup of javadoc in javax.accessibility package

[Philip Race]

A couple of non-critical comments and I don't need to see an updated webrev
for it if you choose to make the changes below.


1)
I know they are only examples but maybe replace sun.com in the various
places it is used (eg this one below), with openjdk.java.net ?


89      * HREF="http://www.sun.com/access">Accessibility</a> this method
   90      * would return a java.net.URL("http://www.sun.com/access.html");

2) http://cr.openjdk.java.net/~serb/8181877/webrev.00/src/java.desktop/share/classes/javax/accessibility/AccessibleValue.java.sdiff.html

66     // /**
   67     // * Get the description of the value of this object.
   68     // *
   69     // * @return description of the value of the object
   70     // */
   71     // public String getAccessibleValueDescription();

Instead of fixing the indentation .. why can't this just be deleted.

-phil.



On 6/9/17, 12:34 PM, Sergey Bylokhov wrote:
> Hello,
> Please review the fix for jdk9.
>
> Bug: https://bugs.openjdk.java.net/browse/JDK-8181877
> Webrev can be found at: http://cr.openjdk.java.net/~serb/8181877/webrev.00
> Specdiff: http://cr.openjdk.java.net/~serb/8181877/specdiff.00/overview-summary.html
>
> In this fix the javadoc is updated and the next rules were applied:
>   -<tag>  should be replaced by {@tag }
>   - 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"/"ClassName" should be wrapped in {@code } when necessary
>   - the order of different tags were unified across the package
> There are also some mixing of different "reference usage", for example "InputStream" vs "input stream", "String" vs "string", etc. I tried to fix some of them.
>
> During the cleanup I found that some of the specs are outdated, for example "package-summary" contains incorrect number of classes/interfaces. In such cases I leaved the spec as-is with intention to rework the text later.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.openjdk.java.net/pipermail/swing-dev/attachments/20170612/d53f458e/attachment.html>