You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by mt...@apache.org on 2009/04/24 20:43:54 UTC

svn commit: r768394 - in /commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime: DirectByteBuffer.java io/Status.java

Author: mturk
Date: Fri Apr 24 18:43:54 2009
New Revision: 768394

URL: http://svn.apache.org/viewvc?rev=768394&view=rev
Log:
Fix javadocs

Modified:
    commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/DirectByteBuffer.java
    commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/io/Status.java

Modified: commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/DirectByteBuffer.java
URL: http://svn.apache.org/viewvc/commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/DirectByteBuffer.java?rev=768394&r1=768393&r2=768394&view=diff
==============================================================================
--- commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/DirectByteBuffer.java (original)
+++ commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/DirectByteBuffer.java Fri Apr 24 18:43:54 2009
@@ -154,8 +154,13 @@
      * memory will be {@code 16} bytes because each requested
      * size is aligned to 8 byte boundary.
      * </p>
+     * <p> Pointer {@code ptr} doesn't have to be pre-allocated. It can be an
+     * empty referece type pointer created by {@code Memory.malloc()} in
+     * which case it will contain the needed memory segment as requested
+     * by the {@code sizes} array.
+     * </p>
      *
-     * @param ptr {@link Pointer} taht holds the native memory area.
+     * @param ptr {@link Pointer} that holds the native memory area.
      * @param sizes Array of lengths for each ByteBuffer.
      * @param off Start offset of the {@code sizes} array.
      * @param len The length of the {@code sizes} array to use.
@@ -188,8 +193,9 @@
      * DirectByteBuffer.allocate(ptr, sizes, 0, sizes.length);
      *
      * </pre>
+     * </p>
      *
-     * @param ptr {@link Pointer} taht holds the native memory area.
+     * @param ptr {@link Pointer} that holds the native memory area.
      * @param sizes Array of lengths for each ByteBuffer.
      * @return The ByteBuffer array with allocated memory
      *

Modified: commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/io/Status.java
URL: http://svn.apache.org/viewvc/commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/io/Status.java?rev=768394&r1=768393&r2=768394&view=diff
==============================================================================
--- commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/io/Status.java (original)
+++ commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/io/Status.java Fri Apr 24 18:43:54 2009
@@ -66,67 +66,31 @@
     }
 
     /* ACR CANONICAL ERROR VALUES */
-    /** @see IS_EACCES */
     public static final int EACCES;
-
-    /** @see IS_EEXIST */
     public static final int EEXIST;
-    /** @see IS_ENAMETOOLONG */
     public static final int ENAMETOOLONG;
-    /** @see IS_ENOENT */
     public static final int ENOENT;
-    /** @see IS_ENOTDIR */
     public static final int ENOTDIR;
-    /** @see IS_ENOSPC */
     public static final int ENOSPC;
-    /** @see IS_ENOMEM */
     public static final int ENOMEM;
-    /** @see IS_EMFILE */
     public static final int EMFILE;
-    /** @see IS_ENFILE */
     public static final int ENFILE;
-    /** @see IS_EBADF */
     public static final int EBADF;
-    /** @see IS_EINVAL */
     public static final int EINVAL;
-
-    /** @see IS_ESPIPE */
     public static final int ESPIPE;
-    /**
-     * @see IS_EAGAIN.
-     * Use STATUS_IS_EAGAIN instead of just testing this value
-     */
     public static final int EAGAIN;
-    /** @see IS_EINTR */
     public static final int EINTR;
-    /** @see IS_ENOTSOCK */
     public static final int ENOTSOCK;
-
-    /** @see IS_ECONNREFUSED */
     public static final int ECONNREFUSED;
-
-    /** @see IS_EINPROGRESS */
     public static final int EINPROGRESS;
-    /**
-     * @see IS_ECONNABORTED
-     * Use ACR_STATUS_IS_ECONNABORTED instead of just testing this value
-     */
     public static final int ECONNABORTED;
-    /** @see IS_ECONNRESET */
     public static final int ECONNRESET;
-    /** @see IS_EHOSTUNREACH */
     public static final int EHOSTUNREACH;
-    /** @see IS_ENETUNREACH */
     public static final int ENETUNREACH;
-    /** @see IS_EFTYPE */
     public static final int EFTYPE;
-    /** @see IS_EPIPE */
     public static final int EPIPE;
-    /** @see IS_EXDEV */
     public static final int EXDEV;
-    /** @see IS_ENOTEMPTY */
     public static final int ENOTEMPTY;
-    /** @see IS_EAFNOSUPPORT */
     public static final int EAFNOSUPPORT;
 
 
@@ -187,49 +151,30 @@
     public static final int ECLASSNOTFOUND          = OS_START_ERROR + 103;
 
 
-    /** @see ACR_STATUS_IS_INCHILD */
     public static final int INCHILD                 = OS_START_STATUS +  1;
-    /** @see ACR_STATUS_IS_INPARENT */
     public static final int INPARENT                = OS_START_STATUS +  2;
-    /** @see ACR_STATUS_IS_DETACH */
     public static final int DETACH                  = OS_START_STATUS +  3;
-    /** @see ACR_STATUS_IS_NOTDETACH */
     public static final int NOTDETACH               = OS_START_STATUS +  4;
-    /** @see ACR_STATUS_IS_CHILD_DONE */
     public static final int CHILD_DONE              = OS_START_STATUS +  5;
-    /** @see ACR_STATUS_IS_CHILD_NOTDONE */
     public static final int CHILD_NOTDONE           = OS_START_STATUS +  6;
-    /** @see ACR_STATUS_IS_TIMEUP */
     public static final int TIMEUP                  = OS_START_STATUS +  7;
-    /** @see ACR_STATUS_IS_INCOMPLETE */
     public static final int INCOMPLETE              = OS_START_STATUS +  8;
     /* empty slot: +9 */
     /* empty slot: +10 */
     /* empty slot: +11 */
-    /** @see ACR_STATUS_IS_BADCH */
     public static final int BADCH                   = OS_START_STATUS + 12;
-    /** @see ACR_STATUS_IS_BADARG */
     public static final int BADARG                  = OS_START_STATUS + 13;
-    /** @see ACR_STATUS_IS_EOF */
     public static final int EOF                     = OS_START_STATUS + 14;
-    /** @see ACR_STATUS_IS_NOTFOUND */
     public static final int NOTFOUND                = OS_START_STATUS + 15;
     /* empty slot: +16 */
     /* empty slot: +17 */
     /* empty slot: +18 */
-    /** @see ACR_STATUS_IS_ANONYMOUS */
     public static final int ANONYMOUS               = OS_START_STATUS + 19;
-    /** @see ACR_STATUS_IS_FILEBASED */
     public static final int FILEBASED               = OS_START_STATUS + 20;
-    /** @see ACR_STATUS_IS_KEYBASED */
     public static final int KEYBASED                = OS_START_STATUS + 21;
-    /** @see ACR_STATUS_IS_EINIT */
     public static final int EINIT                   = OS_START_STATUS + 22;
-    /** @see ACR_STATUS_IS_ENOTIMPL */
     public static final int ENOTIMPL                = OS_START_STATUS + 23;
-    /** @see ACR_STATUS_IS_EMISMATCH */
     public static final int EMISMATCH               = OS_START_STATUS + 24;
-    /** @see ACR_STATUS_IS_EBUSY */
     public static final int EBUSY                   = OS_START_STATUS + 25;
 
     /** Native system error */