<AWT Dev> [9] Review Request: 8043979 Javadoc cleanup of javax.sound.sampled package

Alexander Zvegintsev alexander.zvegintsev at oracle.com
Wed Jun 4 10:46:50 UTC 2014


Hi Sergey,

the fix looks good to me too.

Thanks,

Alexander.

On 06/02/2014 01:15 PM, Sergey Bylokhov wrote:
> Hello.
> Please review another one javadoc "weekend cleanup" in jdk 9 in sound 
> area:
>  - @param, @return should not end with a dot, except a case when more 
> than one sentences are used.
>  - Description of the class/method/field should be followed by dot.
>  - Broken links or typos should be fixed (ex. 
> http://cr.openjdk.java.net/~serb/8043979/specdiff/FloatControl-report.html#method:getMaxLabel())
>
> See the full specdiff: 
> http://cr.openjdk.java.net/~serb/8043979/specdiff/package-summary.html
>
>  - some broken merges from 1999(!!!) were fixed(ex. 
> http://cr.openjdk.java.net/~serb/8043979/webrev.00/src/share/classes/javax/sound/sampled/LineListener.java.udiff.html)
>  - 80 column limit.
>  - empty line after description/before the first tag.
>  - sets of spaces in the middle of text were deleted.
>  - @param, @throws, @return now align, to be more readable.
>  - <tag> should be replaced by {@tag }.
>  - unnecessary imports should be removed.
>  - @see tags can be simplified in some places.
>  - unnecessary spaces and lines can be removed.
>  - @Override should be added when necessary.
>
> Bug: https://bugs.openjdk.java.net/browse/JDK-8043979
> Webrev can be found at: 
> http://cr.openjdk.java.net/~serb/8043979/webrev.00
>



More information about the awt-dev mailing list