From joe.darcy at oracle.com  Wed Mar 12 06:04:56 2014
From: joe.darcy at oracle.com (Joe Darcy)
Date: Tue, 11 Mar 2014 23:04:56 -0700
Subject: <Sound Dev> JDK 9 RFR of JDK-8037173: Fix serial lint warnings in
	sun.audio
Message-ID: <531FF908.6000804@oracle.com>

Hello,

Please review the patch below which addresses

         JDK-8037173: Fix serial lint warnings in sun.audio

Thanks,

-Joe

diff -r 55dc85ff351f 
src/share/classes/sun/audio/InvalidAudioFormatException.java
--- a/src/share/classes/sun/audio/InvalidAudioFormatException.java Tue 
Mar 11 10:46:38 2014 -0700
+++ b/src/share/classes/sun/audio/InvalidAudioFormatException.java Tue 
Mar 11 23:04:25 2014 -0700
@@ -1,5 +1,5 @@
  /*
- * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights 
reserved.
+ * Copyright (c) 1999, 2014, Oracle and/or its affiliates. All rights 
reserved.
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   *
   * This code is free software; you can redistribute it and/or modify it
@@ -29,6 +29,7 @@
  /**
   * Signals an invalid audio stream for the stream handler.
   */
+ at SuppressWarnings("serial") // JDK-implementation class
  final class InvalidAudioFormatException extends IOException {




From Alan.Bateman at oracle.com  Wed Mar 12 07:07:43 2014
From: Alan.Bateman at oracle.com (Alan Bateman)
Date: Wed, 12 Mar 2014 07:07:43 +0000
Subject: <Sound Dev> JDK 9 RFR of JDK-8037173: Fix serial lint warnings
	in sun.audio
In-Reply-To: <531FF908.6000804@oracle.com>
References: <531FF908.6000804@oracle.com>
Message-ID: <532007BF.5050800@oracle.com>

On 12/03/2014 06:04, Joe Darcy wrote:
> Hello,
>
> Please review the patch below which addresses
>
>         JDK-8037173: Fix serial lint warnings in sun.audio
Looks fine (on the assumption that this sun.* exception doesn't leak out 
into the serialized stream of a supported type).

-Alan

From Sergey.Bylokhov at oracle.com  Wed Mar 12 09:28:49 2014
From: Sergey.Bylokhov at oracle.com (Sergey Bylokhov)
Date: Wed, 12 Mar 2014 13:28:49 +0400
Subject: <Sound Dev> JDK 9 RFR of JDK-8037173: Fix serial lint warnings
 in sun.audio
In-Reply-To: <531FF908.6000804@oracle.com>
References: <531FF908.6000804@oracle.com>
Message-ID: <532028D1.1090805@oracle.com>

Hi, Joe,
The fix looks good.

On 3/12/14 10:04 AM, Joe Darcy wrote:
> Hello,
>
> Please review the patch below which addresses
>
>         JDK-8037173: Fix serial lint warnings in sun.audio
>
> Thanks,
>
> -Joe
>
> diff -r 55dc85ff351f 
> src/share/classes/sun/audio/InvalidAudioFormatException.java
> --- a/src/share/classes/sun/audio/InvalidAudioFormatException.java Tue 
> Mar 11 10:46:38 2014 -0700
> +++ b/src/share/classes/sun/audio/InvalidAudioFormatException.java Tue 
> Mar 11 23:04:25 2014 -0700
> @@ -1,5 +1,5 @@
>  /*
> - * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights 
> reserved.
> + * Copyright (c) 1999, 2014, Oracle and/or its affiliates. All rights 
> reserved.
>   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
>   *
>   * This code is free software; you can redistribute it and/or modify it
> @@ -29,6 +29,7 @@
>  /**
>   * Signals an invalid audio stream for the stream handler.
>   */
> + at SuppressWarnings("serial") // JDK-implementation class
>  final class InvalidAudioFormatException extends IOException {
>
>
>


-- 
Best regards, Sergey.


From Sergey.Bylokhov at oracle.com  Sat Mar 15 15:07:15 2014
From: Sergey.Bylokhov at oracle.com (Sergey Bylokhov)
Date: Sat, 15 Mar 2014 19:07:15 +0400
Subject: <Sound Dev> [9] Review Request: 8037117 Javadoc cleanup of
 javax.sound.midi.spi package
Message-ID: <53246CA3.5080808@oracle.com>

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/

-- 
Best regards, Sergey.


From Sergey.Bylokhov at oracle.com  Fri Mar 21 11:01:44 2014
From: Sergey.Bylokhov at oracle.com (Sergey Bylokhov)
Date: Fri, 21 Mar 2014 15:01:44 +0400
Subject: <Sound Dev> [9] Review Request: 8037117 Javadoc cleanup of
 javax.sound.midi.spi package
In-Reply-To: <53246CA3.5080808@oracle.com>
References: <53246CA3.5080808@oracle.com>
Message-ID: <532C1C18.9090801@oracle.com>

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/
>


-- 
Best regards, Sergey.


From Sergey.Bylokhov at oracle.com  Fri Mar 21 11:47:22 2014
From: Sergey.Bylokhov at oracle.com (Sergey Bylokhov)
Date: Fri, 21 Mar 2014 15:47:22 +0400
Subject: <Sound Dev> <AWT Dev> [9] Review Request: 8037117 Javadoc
 cleanup of javax.sound.midi.spi package
In-Reply-To: <532C1FD8.5020508@oracle.com>
References: <53246CA3.5080808@oracle.com> <532C1C18.9090801@oracle.com>
	<532C1FD8.5020508@oracle.com>
Message-ID: <532C26CA.9050803@oracle.com>

On 3/21/14 3:17 PM, Artem Ananiev wrote:
> 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
>
> ?
Yes. it is ok as before:
http://download.java.net/jdk8/docs/api/javax/sound/midi/spi/MidiFileReader.html
>
> 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}.
Actually some  classes use {@code} some {@link}. I can change them to 
use @link on the first reference to a specific class and @code for 
subsequent references.
http://download.java.net/jdk8/docs/api/javax/sound/midi/spi/MidiFileWriter.html
>
> MidiFileWriter: some params are described as
>
> @param sequence the sequence for which ...
>
> while MidiFileReader uses different syntax:
>
> @return a {@code Sequence} object ...
these are a different tags, return has no name and it use type, and 
parameter has name and it is used.
>
> MidiFileWriter.write(): signature contains "throws IOException" only, 
> while JavaDoc also says about IllegalArgumentException.
I guess this is ok, since this is a part of specification and 
IllegalArgumentException is a RuntimeException.
>
> SoundbankReader: the same comment about {@code} and {@link} as above.
>
> Thanks,
>
> Artem
>
> 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/
>>>
>>
>>


-- 
Best regards, Sergey.

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

From artem.ananiev at oracle.com  Fri Mar 21 11:17:44 2014
From: artem.ananiev at oracle.com (Artem Ananiev)
Date: Fri, 21 Mar 2014 15:17:44 +0400
Subject: <Sound Dev> <AWT Dev> [9] Review Request: 8037117 Javadoc
 cleanup of javax.sound.midi.spi package
In-Reply-To: <532C1C18.9090801@oracle.com>
References: <53246CA3.5080808@oracle.com> <532C1C18.9090801@oracle.com>
Message-ID: <532C1FD8.5020508@oracle.com>

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.

Thanks,

Artem

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/
>>
>
>