javadoc warning fixes

Alan Bateman Alan.Bateman at Sun.COM
Wed Jul 29 12:46:41 PDT 2009


Martin Buchholz wrote:
> Here are some easy javadoc warning fixes:
>
> http://cr.openjdk.java.net/~martin/webrevs/openjdk7/nio-javadoc-warnings/
>   
Thanks for catching these.

The link to bind (in DatagramChannel) is already fixed in the nio 
repository, I just hadn't got around to pushing it. No problem if fix it 
in jdk7/tl/jdk first.

In the attribute/package-info.java I think I prefer "lookup" because 
that is consistent with the class description in 
UserPrincipalLookupService. I agree with the other fixes (the wrong 
package for the links to CME is kinda embarrassing).

Anyway, I've created so you can push these:
  6866554: Javadoc warnings in channels and file packages

> Here are more unfixed warnings in nio-land that I'm not addressing:
>
> ../../src/share/classes/java/nio/file/FileRef.java:48: warning - Tag
> @see: reference not found: java.io.Inputs
> ../../src/share/classes/java/nio/file/FileRef.java:48: warning - Tag
> @see: reference not found: java.io.Outputs
> ../../src/share/classes/java/nio/channels/package-info.java:293:
> warning - Tag @link: reference not found: java.nio.MappedBigByteBuffer
>   
The link to the non-existent MappedBigByteBuffer is fixed in the nio 
repository (someone reported a few months ago).  Can you include it in 
your changes?

diff -r aad1aebdd282 -r 314f51fc0d38 
src/share/classes/java/nio/channels/package-info.java
--- a/src/share/classes/java/nio/channels/package-info.java     Mon Feb 
16 16:43:12 2009 +0000
+++ b/src/share/classes/java/nio/channels/package-info.java     Mon Jun 
29 18:39:08 2009 +0100
@@ -115,8 +115,8 @@
  *     <td>Reads, writes, maps, and manipulates files</td></tr>
  * <tr><td valign=top><tt>{@link java.nio.channels.FileLock}</tt></td>
  *     <td>A lock on a (region of a) file</td></tr>
- * <tr><td valign=top><tt>{@link java.nio.MappedByteBuffer}/{@link 
java.nio.MappedBigByteBuffer}&nbsp;&nbsp;</tt></td>
- *     <td>A direct byte buffer or big byte buffer mapped to a region 
of a&nbsp;file</td></tr>
+ * <tr><td valign=top><tt>{@link 
java.nio.MappedByteBuffer}&nbsp;&nbsp;</tt></td>
+ *     <td>A direct byte buffer mapped to a region of a&nbsp;file</td></tr>
  * </table></blockquote>
  *
  * <p> The {@link java.nio.channels.FileChannel} class supports the usual


I hope to get Inputs/Outputs into m5 so the links in FileRef will be okay.

-Alan.



More information about the nio-dev mailing list