<Swing Dev> Review Request for 8044281: Fix doclint warnings (missing javadoc @param and @return tags) in javax.swing.text - Part 1 of 2

[Petr Pchelko]

Hello, Rocky.

A couple of comments.

1. Please control the correct indentation of the second line of the @param/@return tag descriptions. You have many places where it's incorrect.
2. Please use @code instead of <code></code>
3. AbstractWriter - no need to mention variable names in the javadoc. Please remove it.
4. AbstractWriter:374 - better to say {@code true} if the lines will be wrapped, {@code false} otherwise. Also please remove the last line of the doc.
5. The indentation of @param comments is incorrect. You have:
>  * @param chars          character array containing content to write
>  * @param startIndex   offset in the array to start writing from;
>  *                                  0 starts at the beginning
>  * @param length        number of characters to write


And you should have:
>  * @param chars character array containing content to write
>  * @param startIndex offset in the array to start writing from;
>  *                                 0 starts at the beginning
>  * @param length number of characters to write

6. AsyncBoxView:451 - it's not a boolean!

With best regards. Petr.

On 10 июля 2014 г., at 13:36, Rocky Sloan <rocky.sloan at oracle.com> wrote:

> Hello,
> 
> Could you please review Part 1 of the fix for the following bug:
> https://bugs.openjdk.java.net/browse/JDK-8044261
> 
> This is part 1 of 2.
> 
> Webrev corresponding:
> http://cr.openjdk.java.net/~yan/8044261/webrev.01/
> 
> Change:
> Add missing @return and @param javadoc tags in javax.swing.text classes to fix doclint warnings.
> 
> Thanks,
> 
> - Rocky
>