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

Artem Ananiev artem.ananiev at oracle.com
Fri Mar 21 11:17:44 UTC 2014

Hi, Sergey,

it looks fine.

Have you verified that

@see InputStream#mark

is resolved by JavaDoc to the correct link? Shouldn't it be

@see java.io.InputStream#mark


MidiFileWriter: class JavaDoc contains both {@code} and {@link}, do we 
need to use one of them? Other classes contain {@code} only and don't 
use {@link}.

MidiFileWriter: some params are described as

@param sequence the sequence for which ...

while MidiFileReader uses different syntax:

@return a {@code Sequence} object ...

MidiFileWriter.write(): signature contains "throws IOException" only, 
while JavaDoc also says about IllegalArgumentException.

SoundbankReader: the same comment about {@code} and {@link} as above.



On 3/21/2014 3:01 PM, Sergey Bylokhov wrote:
> Any volunteers?
> On 3/15/14 7:07 PM, Sergey Bylokhov wrote:
>> Hello.
>> Please review a javadoc "weekend cleanup" in jdk 9.
>>  - 80 column limit
>>  - <tags> replaced to @tags
>>  - empty line after description/before the first tag
>>  - @param, @throws, @return now align, to be more readable
>> Bug: https://bugs.openjdk.java.net/browse/JDK-8037117
>> Webrev can be found at:
>> http://cr.openjdk.java.net/~serb/8037117/webrev.01/

More information about the awt-dev mailing list