<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="Content-Type">
</head>
<body bgcolor="#FFFFFF" text="#000000">
<div class="moz-cite-prefix">On 3/21/14 3:17 PM, Artem Ananiev
wrote:<br>
</div>
<blockquote cite="mid:532C1FD8.5020508@oracle.com" type="cite">Hi,
Sergey,
<br>
<br>
it looks fine.
<br>
<br>
Have you verified that
<br>
<br>
@see InputStream#mark
<br>
<br>
is resolved by JavaDoc to the correct link? Shouldn't it be
<br>
<br>
@see java.io.InputStream#mark
<br>
<br>
?
<br>
</blockquote>
Yes. it is ok as before:<br>
<a class="moz-txt-link-freetext" href="http://download.java.net/jdk8/docs/api/javax/sound/midi/spi/MidiFileReader.html">http://download.java.net/jdk8/docs/api/javax/sound/midi/spi/MidiFileReader.html</a><br>
<blockquote cite="mid:532C1FD8.5020508@oracle.com" type="cite">
<br>
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}.
<br>
</blockquote>
Actually some classes use {@code} some {@link}. I can change them
to use @link on the first reference to a specific class and @code
<meta http-equiv="content-type" content="text/html;
charset=ISO-8859-1">
for subsequent references.<br>
<a class="moz-txt-link-freetext" href="http://download.java.net/jdk8/docs/api/javax/sound/midi/spi/MidiFileWriter.html">http://download.java.net/jdk8/docs/api/javax/sound/midi/spi/MidiFileWriter.html</a><br>
<meta http-equiv="content-type" content="text/html;
charset=ISO-8859-1">
<blockquote cite="mid:532C1FD8.5020508@oracle.com" type="cite">
<br>
MidiFileWriter: some params are described as
<br>
<br>
@param sequence the sequence for which ...
<br>
<br>
while MidiFileReader uses different syntax:
<br>
<br>
@return a {@code Sequence} object ...
<br>
</blockquote>
these are a different tags, return has no name and it use type, and
parameter has name and it is used.<br>
<blockquote cite="mid:532C1FD8.5020508@oracle.com" type="cite">
<br>
MidiFileWriter.write(): signature contains "throws IOException"
only, while JavaDoc also says about IllegalArgumentException.
<br>
</blockquote>
I guess this is ok, since this is a part of specification and
IllegalArgumentException is a RuntimeException.<br>
<blockquote cite="mid:532C1FD8.5020508@oracle.com" type="cite">
<br>
SoundbankReader: the same comment about {@code} and {@link} as
above.
<br>
<br>
Thanks,
<br>
<br>
Artem
<br>
<br>
On 3/21/2014 3:01 PM, Sergey Bylokhov wrote:
<br>
<blockquote type="cite">Any volunteers?
<br>
<br>
On 3/15/14 7:07 PM, Sergey Bylokhov wrote:
<br>
<blockquote type="cite">Hello.
<br>
Please review a javadoc "weekend cleanup" in jdk 9.
<br>
- 80 column limit
<br>
- <tags> replaced to @tags
<br>
- empty line after description/before the first tag
<br>
- @param, @throws, @return now align, to be more readable
<br>
<br>
Bug: <a class="moz-txt-link-freetext" href="https://bugs.openjdk.java.net/browse/JDK-8037117">https://bugs.openjdk.java.net/browse/JDK-8037117</a>
<br>
Webrev can be found at:
<br>
<a class="moz-txt-link-freetext" href="http://cr.openjdk.java.net/~serb/8037117/webrev.01/">http://cr.openjdk.java.net/~serb/8037117/webrev.01/</a>
<br>
<br>
</blockquote>
<br>
<br>
</blockquote>
</blockquote>
<br>
<br>
<pre class="moz-signature" cols="72">--
Best regards, Sergey. </pre>
</body>
</html>