<Swing Dev> Review Request for 8042284: Add block tags for @return and @param to swing plaf classes

Phil Race philip.race at oracle.com
Thu Jul 17 19:43:13 UTC 2014


http://sqeweb.us.oracle.com/coretools/ssides/webrevs/8042284/8042284.4/src/share/classes/javax/swing/plaf/ComponentUI.java.sdiff.html

You didn't do anything about the (many) uses of <code>FOO</code> like 
this :-

* Returns <code>true</code> if the specified <i>x,y</i> location is
  231      * contained within the look and feel's defined shape of the specified
  232      * component. <code>x</code> and <code>y</code> ar

Elsewhere (eg) this file
http://cr.openjdk.java.net/~serb/8050852/webrev.02/src/share/classes/javax/sound/midi/Instrument.java.sdiff.html
in this thread : - 
http://mail.openjdk.java.net/pipermail/awt-dev/2014-July/008231.html

I'm seeing these replaced by {@code FOO}

You have used that syntax in your new doc but left alone the others.

So it seems you are focused solely on the @param and @throws tags.

Is the rest being handled by someone else ?

-phil.

On 7/17/2014 12:32 PM, Steve Sides wrote:
> Hello,
>   This is a redo of the changes so that they are based on jdk9/client 
> rather than jdk9/dev.
> Could you please review these fixes for doclint warnings for javax/swing/plaf.
> This addresses mostly just missing @param and @return tags.
>
> bugID:
> https://bugs.openjdk.java.net/browse/JDK-8042284
>
> Webrev corresponding:
> http://sqeweb.us.oracle.com/coretools/ssides/webrevs/8042284/8042284.4/
>
> thanks,
>
> steve
>
>
> On 7/1/2014 8:50 AM, Steve Sides wrote:
>> ------------------------------------------------------------------------
>> Hello,
>>
>> Could you please review the fix for the following bug:
>> https://bugs.openjdk.java.net/browse/JDK-8042284
>>
>> Webrev corresponding:
>> http://cr.openjdk.java.net/~ssides/8042284/8042284.3/
>>
>> This addresses missing @parm and @return block tags in javadoc for
>> javax/swing/plaf classes as noted by doclint.
>>
>> It does not address methods which are missing javadoc comment altogether,
>> of which there are several.
>>
>>
>> thanks,
>>
>> -steve
>>
>




More information about the swing-dev mailing list