Author: mturk
Date: Tue Apr 14 18:29:16 2009
New Revision: 764916
URL: http://svn.apache.org/viewvc?rev=764916&view=rev
Log:
Few more javadoc unifications
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/JavaVersion.java
commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/OS.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=764916&r1=764915&r2=764916&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
Tue Apr 14 18:29:16 2009
@@ -18,17 +18,16 @@
import java.nio.ByteBuffer;
-/** DirectByteBuffer
- * Support for managing direct ByteBuffers.
- * <br/><br />
- * <b>Warning:</b><br />Using this class impropery may crash the running JVM.
+/** Manages direct ByteBuffers
+ * <br/><br/>
+ * <b>Warning:</b><br/>Using this class impropery may crash the running JVM.
* Any method call after free method was called might write or read from
* the memory location that has been already allocated for
* something else.
* Using this class methods on ByteBuffers that were not created by
* DirectByteBuffer.allocate methods will almost certainly crash the
* running JVM.
- * @author Mladen Turk
+ * @since Runtime 1.0
*/
public final class DirectByteBuffer {
@@ -52,7 +51,7 @@
IndexOutOfBoundsException;
/**
- * Allocate a new ByteBuffer from memory
+ * Allocate a new ByteBuffer from memory.
* @param size The amount of memory to allocate
* @return The ByteBuffer with allocated memory
*
@@ -66,7 +65,8 @@
}
/**
- * Allocate a new ByteBuffer from memory and set all of the memory to 0
+ * Allocate a new ByteBuffer from memory and set all of the memory
+ * bytes to zero.
* @param size Length in bytes of each element.
* @return The ByteBuffer with allocated memory
*
@@ -81,7 +81,7 @@
/**
* Allocate a new ByteBuffer from already allocated memory.
- * <br /><b>Warning:</b><br />
+ * <br/><br/><b>Warning:</b><br/>
* Allocated memory must be provided from call to the
* <code>address</code> method or by some other valid method that returns
* the valid memory address.
@@ -122,9 +122,9 @@
}
/**
- * Deallocates or frees a memory block used by ByteBuffer
- * <br />
- * <b>Warning:</b><br />Call this method only on ByteBuffers
+ * Deallocates or frees a memory block used by ByteBuffer.
+ * <br/><br/><b>Warning:</b><br/>
+ * Invoke this method only on ByteBuffers
* that were created by <code>DirectByteBuffer.allocate</code> methods.
* @param buf Previously allocated ByteBuffer to be deallocated.
*
Modified:
commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/JavaVersion.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/JavaVersion.java?rev=764916&r1=764915&r2=764916&view=diff
==============================================================================
---
commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/JavaVersion.java
(original)
+++
commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/JavaVersion.java
Tue Apr 14 18:29:16 2009
@@ -18,25 +18,24 @@
import java.util.Properties;
-/** JavaVersion
- * <br />
- * Class that uses system properties to match our OS class
+/**
+ * Class that uses system properties to match <code>OS</code> class
* for system name and processor.
* Used when extracting the native libraries from the .jar to find
* the correct path of dynamic shared library
- * <PRE>
-Constructed path for native libraries:
-
- /META-LIB/getSysname()/getProcessor()/<library>
-
-Example for Linux using 64-bit JVM
-
- /META-LIB/linux/x86_64/libacr.so
-
- </PRE
+ * <pre>
+ * Constructed path for native libraries:
+ *
+ * /META-LIB/getSysname()/getProcessor()/<library>
+ *
+ * Example for Linux using 64-bit JVM
+ *
+ * /META-LIB/linux/x86_64/libacr.so
*
- * @author Mladen Turk
+ * </pre>
*
+ * @see OS
+ * @since Runtime 1.0
*/
public final class JavaVersion {
Modified:
commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/OS.java
URL:
http://svn.apache.org/viewvc/commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/OS.java?rev=764916&r1=764915&r2=764916&view=diff
==============================================================================
---
commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/OS.java
(original)
+++
commons/sandbox/runtime/trunk/src/main/java/org/apache/commons/runtime/OS.java
Tue Apr 14 18:29:16 2009
@@ -16,9 +16,9 @@
package org.apache.commons.runtime;
-/** OS
+/** Operating system type and version info.
*
- * @author Mladen Turk
+ * @since Runtime 1.0
*
*/
public final class OS {
