[nio dev] [8] Review request for 8028049 : Tidy warnings cleanup for packages java.nio/java.io

[Joe Darcy]

On 11/11/2013 3:27 AM, Alan Bateman wrote:
> On 11/11/2013 06:02, Sergey Lugovoy wrote:
>> Hi all,
>> please review the fix
>> http://cr.openjdk.java.net/~yan/8028049/webrev.00/
>> for
>> https://bugs.openjdk.java.net/browse/JDK-8028049
>>
>> This patch cleanup tidy warnings for generated html documentation, 
>> and do not
>> affect the appearance of the documentation.
>>
> Thanks for working on this.
>
> I don't understand the need for the breaks (the replacements of <p> 
> with <br/>), are you sure these are needed?

Yes, I would assume in a situation like

   * end of stream rather than throwing an exception.
- * <p>
+ * <br/>
   *
   * @author  Frank Yellin

it would suffice just to remove the <p> tag, resulting in

   * end of stream rather than throwing an exception.
- * <p>
   *
   * @author  Frank Yellin



>
> In the package.html you've changed it from </code> .. <code> to <code> 
> .. </code>. I think it would be better to just remove the code tags as 
> we are already in a link (this is the reason why it was originally 
> done as </code> .. <code>).

For this construct,

    <li><p> A byte buffer can be created by {@link
-  java.nio.channels.FileChannel#map </code><i>mapping</i><code>} a 
region of a
+  java.nio.channels.FileChannel#map <code><i>mapping</i></code>} a 
region of a

you should replace with the linkplain tag.

Cheers,

-Joe


>
> Otherwise I think it looks okay. I assume you'll run doclint, in 
> addition to tidy, to make sure that we are clean before pushing this.
>
> -Alan.