<Sound Dev> <AWT Dev> [9] Review Request: 8050852 Javadoc cleanup of javax.sound.midi package

[Phil Race]

I had started on this but there was a lot to wade through

Here 
http://cr.openjdk.java.net/~serb/8050852/webrev.02/src/share/classes/javax/sound/midi/MidiDevice.java.sdiff.html

you changed 'public static class Info' -> 'class Info'

This made me think. I presume the point is that a class nested within an 
interface
is implicitly static even if not declared so, so you removed it.
However I have no idea  if JCK signature tests will need to be updated.
I suggest you inquire.

You may want to correct the (pre-existing) spelling mistake
here before you push :-
http://cr.openjdk.java.net/~serb/8050852/webrev.02/src/share/classes/javax/sound/midi/MidiDevice.java.sdiff.html

48  * {@code MidiSystem.getTransmitter} is implementation-dependant unless the

dependant->dependent


Changes (like) this one surprised me too :-

http://cr.openjdk.java.net/~serb/8050852/webrev.02/src/share/classes/javax/sound/sampled/spi/AudioFileWriter.java.sdiff.html

So we add an import statement just to keep some javadoc tool happy ?
Was this from doclint ? Did you question whether that was really something
doclint should enforce rather than just allowing the fully qualified name ?

It wouldn't surprise me if some other tool were to consider this an 
un-used import
and delete it.

-phil

On 7/23/14 2:44 AM, Sergey Bylokhov wrote:
> Hello,
> Any volunteers to be a second reviewer?
>
> On 17.07.2014 12:18, Petr Pchelko wrote:
>> Hello, Sergey.
>>
>> The fix looks good to me.
>>
>> With best regards. Petr.
>>
>> On 16 июля 2014 г., at 20:56, Sergey Bylokhov 
>> <Sergey.Bylokhov at oracle.com> wrote:
>>
>>> Hello.
>>> Please review another one javadoc 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.
>>> - @param, @throws, @return now align, to be more readable.
>>> - @see tags simplified in some places.
>>> - Description of the class/method/field should be followed by dot.
>>> - Broken links/typos fixed
>>> - 80 column limit.
>>> - sets of spaces in the middle of text were deleted.
>>> - <tag> replaced by {@tag }.
>>> - unnecessary imports were removed.
>>>
>>> Bug: https://bugs.openjdk.java.net/browse/JDK-8050852
>>> See the full specdiff: 
>>> http://cr.openjdk.java.net/~serb/8050852/javadoc/overview-summary.html
>>> Webrev can be found at: 
>>> http://cr.openjdk.java.net/~serb/8050852/webrev.02
>>>
>>> -- 
>>> Best regards, Sergey.
>>>
>
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.openjdk.java.net/pipermail/sound-dev/attachments/20140723/fef69c00/attachment.html>