<Swing Dev> Review request for JDK-8046590 fix doclint issues in swing classes, part 1 of 4

[Petr Pchelko]

Hello, Steve.

> These were actually intentional after I read on Stephen Colbournes blog on Javadoc coding standards noted 2 spaces after param name, so I checked and noticed all the @param samples on "How to Write Doc Comments for the Javadoc Tool" also had 2 spaces (or more) after the param name.
I would have agreed if we didn’t have 1 space everywhere in else in the same file. Thank you for a reference to a nice reading.

The fix looks good.

With best regards. Petr.

> On Jun 21, 2014, at 9:03 AM, Steve Sides <steve.sides at oracle.com> wrote:
> 
> 
> On 6/19/2014 12:17 AM, Petr Pchelko wrote:
>> Hello, Steve.
>> 
>> A couple of comments:
>> 
>> 1. CellRendererPane:192 - I've never seen that we write one-liner javadoc.
>>     May be it's better to split it into 3 lines to conform to the common pattern?
> I think I borrowed that from existing in JFrame. I put it in several places....changed them to 3 lines.
> 
>> 2. DefaultDesktopManager:480 - "iconifyFrame()" is definetely a candidate to add @code tag
>>     line 603 - you have an extra space before "the"
>> 3. InputMap:78 - extra space
> These were actually intentional after I read on Stephen Colbournes blog on Javadoc coding standards noted 2 spaces after param name, so I checked and noticed all the @param samples on "How to Write Doc Comments for the Javadoc Tool" also had 2 spaces (or more) after the param name.
> However, I changed the above to 1 for consistency.
>>     line 91: the javadoc comment "an Object" is quite useless. You could add something like "an action map key"
>> 4. JEditorPane: 1256 as you are updating the doc for this method, could you please also update this line to also use @code
>> 5. JFileChooser:2005 the one-liner javadoc
>> 6. JMenu: 764 strange alignment of the block.
> 
> all other noted issues addressed,
> http://cr.openjdk.java.net/~ssides/8046590/8046590.3/
> 
> -steve
> 
>> 
>> With best regards. Petr.
>> 
>> On 19 июня 2014 г., at 3:34, Steve Sides <steve.sides at oracle.com> wrote:
>> 
>>> Hello,
>>> 
>>> Could you please review the fix for the following bug:
>>> https://bugs.openjdk.java.net/browse/JDK-8046590
>>> 
>>> Webrev corresponding: (there were a couple typos in rev 1)
>>> http://cr.openjdk.java.net/~ssides/8046590/8046590.2/
>>> 
>>> This addresses missing @parm and @return block tags in javadoc for
>>> javax/swing classes as noted by doclint and some reformatting.
>>> 
>>> thanks,
>>> 
>>> -steve
>>> 
>