harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From telli...@apache.org
Subject svn commit: r770909 [1/10] - in /harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang: ./ ref/ reflect/
Date Sat, 02 May 2009 08:09:57 GMT
Author: tellison
Date: Sat May  2 08:09:50 2009
New Revision: 770909

URL: http://svn.apache.org/viewvc?rev=770909&view=rev
Log:
Apply slightly modified patch for HARMONY-6194 (Javadocs for java.lang.*)

Modified:
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AbstractMethodError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AbstractStringBuilder.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Appendable.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ArithmeticException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ArrayIndexOutOfBoundsException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ArrayStoreException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AssertionError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Boolean.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Byte.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/CharSequence.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Character.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ClassCastException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ClassCircularityError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ClassFormatError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ClassNotFoundException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/CloneNotSupportedException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Cloneable.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Comparable.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Deprecated.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Double.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Enum.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/EnumConstantNotPresentException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Error.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Exception.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ExceptionInInitializerError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Float.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/IllegalAccessError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/IllegalAccessException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/IllegalArgumentException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/IllegalMonitorStateException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/IllegalStateException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/IllegalThreadStateException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/IncompatibleClassChangeError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/IndexOutOfBoundsException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/InheritableThreadLocal.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/InstantiationError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/InstantiationException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Integer.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/InternalError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/InterruptedException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Iterable.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/LinkageError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Long.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Math.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/NegativeArraySizeException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/NoClassDefFoundError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/NoSuchFieldError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/NoSuchFieldException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/NoSuchMethodError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/NoSuchMethodException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/NullPointerException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Number.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/NumberFormatException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/OutOfMemoryError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Override.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Process.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ProcessBuilder.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Readable.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Runnable.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/RuntimeException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/RuntimePermission.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/SecurityException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/SecurityManager.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Short.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/StackOverflowError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/StrictMath.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/String.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/StringBuffer.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/StringBuilder.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/StringIndexOutOfBoundsException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/SuppressWarnings.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ThreadDeath.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ThreadLocal.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/TypeNotPresentException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/UnknownError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/UnsatisfiedLinkError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/UnsupportedClassVersionError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/UnsupportedOperationException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/VerifyError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/VirtualMachineError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Void.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ref/ReferenceQueue.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/reflect/AnnotatedElement.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/reflect/GenericArrayType.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/reflect/GenericDeclaration.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/reflect/GenericSignatureFormatError.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/reflect/InvocationHandler.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/reflect/InvocationTargetException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/reflect/MalformedParameterizedTypeException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/reflect/Member.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/reflect/Modifier.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/reflect/ParameterizedType.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/reflect/Proxy.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/reflect/ReflectPermission.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/reflect/Type.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/reflect/TypeVariable.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/reflect/UndeclaredThrowableException.java
    harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/reflect/WildcardType.java

Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AbstractMethodError.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AbstractMethodError.java?rev=770909&r1=770908&r2=770909&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AbstractMethodError.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AbstractMethodError.java Sat May  2 08:09:50 2009
@@ -18,10 +18,9 @@
 package java.lang;
 
 /**
- * This error is thrown when the VM notices that an attempt is being made to
- * invoke an abstract method.
- * </p>
- * Note that this can only occur when inconsistent class files are being loaded,
+ * Thrown by the virtual machine when an abstract method is called.
+ * <p>
+ * Note that this can only occur when inconsistent class files have been loaded,
  * since invoking an abstract method is a compile time error.
  */
 public class AbstractMethodError extends IncompatibleClassChangeError {
@@ -29,18 +28,19 @@
     private static final long serialVersionUID = -1654391082989018462L;
 
     /**
-     * Constructs a new instance of this class with its walkback filled in.
+     * Constructs a new {@code AbstractMethodError} that includes the current
+     * stack trace.
      */
     public AbstractMethodError() {
         super();
     }
 
     /**
-     * Constructs a new instance of this class with its walkback and message
-     * filled in.
-     * 
+     * Constructs a new {@code AbstractMethodError} with the current stack trace
+     * and the specified detail message.
+     *
      * @param detailMessage
-     *            String The detail message for the exception.
+     *            the detail message for this error.
      */
     public AbstractMethodError(String detailMessage) {
         super(detailMessage);

Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AbstractStringBuilder.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AbstractStringBuilder.java?rev=770909&r1=770908&r2=770909&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AbstractStringBuilder.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AbstractStringBuilder.java Sat May  2 08:09:50 2009
@@ -25,11 +25,10 @@
 /**
  * A modifiable {@link CharSequence sequence of characters} for use in creating
  * and modifying Strings. This class is intended as a base class for
- * {@link java.lang.StringBuffer} and {@link java.lang.StringBuilder}.
- * 
- * @see java.lang.StringBuffer
- * @see java.lang.StringBuilder
- * 
+ * {@link StringBuffer} and {@link StringBuilder}.
+ *
+ * @see StringBuffer
+ * @see StringBuilder
  * @since 1.5
  */
 abstract class AbstractStringBuilder {
@@ -169,11 +168,9 @@
     }
 
     /**
-     * Answers the number of characters this StringBuffer can hold without
-     * growing.
-     * 
-     * @return the capacity of this StringBuffer
+     * Returns the number of characters that can be held without growing.
      * 
+     * @return the capacity
      * @see #ensureCapacity
      * @see #length
      */
@@ -182,14 +179,14 @@
     }
 
     /**
-     * Retrieves the character at the <code>index</code>.
+     * Retrieves the character at the {@code index}.
      * 
      * @param index
-     *            The index of character in this object to retrieve.
-     * @return The char value.
+     *            the index of the character to retrieve.
+     * @return the char value.
      * @throws IndexOutOfBoundsException
-     *             if <code>index</code> is negative or greater than or equal
-     *             to the current {@link #length()}.
+     *             if {@code index} is negative or greater than or equal to the
+     *             current {@link #length()}.
      */
     public char charAt(int index) {
         if (index < 0 || index >= count) {
@@ -250,14 +247,14 @@
     /**
      * Ensures that this object has a minimum capacity available before
      * requiring the internal buffer to be enlarged. The general policy of this
-     * method is that if the <code>minimumCapacity</code> is larger than the
-     * current {@link #capacity()}, then the capacity will be increased to the
-     * largest value of either the <code>minimumCapacity</code> or the current
-     * capacity multiplied by two plus two. Although this is the general policy,
-     * there is no guarantee that the capacity will change.
+     * method is that if the {@code minimumCapacity} is larger than the current
+     * {@link #capacity()}, then the capacity will be increased to the largest
+     * value of either the {@code minimumCapacity} or the current capacity
+     * multiplied by two plus two. Although this is the general policy, there is
+     * no guarantee that the capacity will change.
      * 
      * @param min
-     *            The new minimum capacity to set.
+     *            the new minimum capacity to set.
      */
     public void ensureCapacity(int min) {
         if (min > value.length) {
@@ -266,27 +263,23 @@
     }
 
     /**
-     * Copies the requested sequence of characters to be copied to the
-     * <code>char[]</code> passed.
-     * 
+     * Copies the requested sequence of characters to the {@code char[]} passed
+     * starting at {@code destStart}.
+     *
      * @param start
-     *            The inclusive start index of the characters to copy from this
-     *            object.
+     *            the inclusive start index of the characters to copy.
      * @param end
-     *            The exclusive end index of the characters to copy from this
-     *            object.
+     *            the exclusive end index of the characters to copy.
      * @param dest
-     *            The <code>char[]</code> to copy the characters to.
+     *            the {@code char[]} to copy the characters to.
      * @param destStart
-     *            The inclusive start index of the <code>dest</code> parameter
-     *            to begin copying to.
+     *            the inclusive start index of {@code dest} to begin copying to.
      * @throws IndexOutOfBoundsException
-     *             if the <code>start</code> is negative, the
-     *             <code>destStart</code> is negative, the <code>start</code>
-     *             is greater than <code>end</code>, the <code>end</code>
-     *             is greater than the current {@link #length()} or
-     *             <code>destStart + end - begin</code> is greater than
-     *             <code>dest.length</code>.
+     *             if the {@code start} is negative, the {@code destStart} is
+     *             negative, the {@code start} is greater than {@code end}, the
+     *             {@code end} is greater than the current {@link #length()} or
+     *             {@code destStart + end - begin} is greater than
+     *             {@code dest.length}.
      */
     public void getChars(int start, int end, char[] dest, int destStart) {
         if (start > count || end > count || start > end) {
@@ -362,9 +355,9 @@
     }
 
     /**
-     * The current length of this object.
+     * The current length.
      * 
-     * @return the number of characters in this StringBuffer
+     * @return the number of characters contained in this instance.
      */
     public int length() {
         return count;
@@ -514,15 +507,15 @@
     }
 
     /**
-     * Sets the character at the <code>index</code> in this object.
+     * Sets the character at the {@code index}.
      * 
      * @param index
      *            the zero-based index of the character to replace.
      * @param ch
      *            the character to set.
      * @throws IndexOutOfBoundsException
-     *             if <code>index</code> is negative or greater than or equal
-     *             to the current {@link #length()}.
+     *             if {@code index} is negative or greater than or equal to the
+     *             current {@link #length()}.
      */
     public void setCharAt(int index, char ch) {
         if (0 > index || index >= count) {
@@ -538,14 +531,12 @@
     /**
      * Sets the current length to a new value. If the new length is larger than
      * the current length, then the new characters at the end of this object
-     * will contain the <code>char</code> value of <code>&#92;u0000</code>.
+     * will contain the {@code char} value of {@code \u0000}.
      * 
      * @param length
-     *            the new length of this StringBuffer
-     * 
+     *            the new length of this StringBuffer.
      * @exception IndexOutOfBoundsException
-     *                when <code>length < 0</code>
-     * 
+     *                if {@code length < 0}.
      * @see #length
      */
     public void setLength(int length) {
@@ -570,15 +561,15 @@
     }
 
     /**
-     * Returns the String value of the subsequence of this object from the
-     * <code>start</code> index to the current end.
+     * Returns the String value of the subsequence from the {@code start} index
+     * to the current end.
      * 
      * @param start
-     *            The inclusive start index to begin the subsequence.
-     * @return A String containing the subsequence.
+     *            the inclusive start index to begin the subsequence.
+     * @return a String containing the subsequence.
      * @throws StringIndexOutOfBoundsException
-     *             if <code>start</code> is negative or greater than the
-     *             current {@link #length()}.
+     *             if {@code start} is negative or greater than the current
+     *             {@link #length()}.
      */
     public String substring(int start) {
         if (0 <= start && start <= count) {
@@ -593,17 +584,17 @@
     }
 
     /**
-     * Returns the String value of the subsequence of this object from the
-     * <code>start</code> index to the <code>start</code> index.
+     * Returns the String value of the subsequence from the {@code start} index
+     * to the {@code end} index.
      * 
      * @param start
-     *            The inclusive start index to begin the subsequence.
+     *            the inclusive start index to begin the subsequence.
      * @param end
-     *            The exclusive end index to end the subsequence.
-     * @return A String containing the subsequence.
+     *            the exclusive end index to end the subsequence.
+     * @return a String containing the subsequence.
      * @throws StringIndexOutOfBoundsException
-     *             if <code>start</code> is negative, greater than the current
-     *             {@link #length()} or greater than <code>end</code>.
+     *             if {@code start} is negative, greater than {@code end} or if
+     *             {@code end} is greater than the current {@link #length()}.
      */
     public String substring(int start, int end) {
         if (0 <= start && start <= end && end <= count) {
@@ -618,9 +609,9 @@
     }
 
     /**
-     * Returns the current String representation of this object.
+     * Returns the current String representation.
      * 
-     * @return a String containing the characters in this StringBuilder.
+     * @return a String containing the characters in this instance.
      */
     @Override
     public String toString() {
@@ -638,18 +629,17 @@
     }
 
     /**
-     * Returns a <code>CharSequence</code> of the subsequence of this object
-     * from the <code>start</code> index to the <code>start</code> index.
+     * Returns a {@code CharSequence} of the subsequence from the {@code start}
+     * index to the {@code end} index.
      * 
      * @param start
-     *            The inclusive start index to begin the subsequence.
+     *            the inclusive start index to begin the subsequence.
      * @param end
-     *            The exclusive end index to end the subsequence.
-     * @return A CharSequence containing the subsequence.
+     *            the exclusive end index to end the subsequence.
+     * @return a CharSequence containing the subsequence.
      * @throws IndexOutOfBoundsException
-     *             if <code>start</code> is negative, greater than the current
-     *             {@link #length()} or greater than <code>end</code>.
-     * 
+     *             if {@code start} is negative, greater than {@code end} or if
+     *             {@code end} is greater than the current {@link #length()}.
      * @since 1.4
      */
     public CharSequence subSequence(int start, int end) {
@@ -657,17 +647,14 @@
     }
 
     /**
-     * Searches in this StringBuffer for the first index of the specified
-     * character. The search for the character starts at the beginning and moves
-     * towards the end.
+     * Searches for the first index of the specified character. The search for
+     * the character starts at the beginning and moves towards the end.
      * 
      * @param string
-     *            the string to find
-     * @return the index in this StringBuffer of the specified character, -1 if
-     *         the character isn't found
-     * 
+     *            the string to find.
+     * @return the index of the specified character, -1 if the character isn't
+     *         found.
      * @see #lastIndexOf(String)
-     * 
      * @since 1.4
      */
     public int indexOf(String string) {
@@ -675,19 +662,16 @@
     }
 
     /**
-     * Searches in this StringBuffer for the index of the specified character.
-     * The search for the character starts at the specified offset and moves
-     * towards the end.
+     * Searches for the index of the specified character. The search for the
+     * character starts at the specified offset and moves towards the end.
      * 
      * @param subString
-     *            the string to find
+     *            the string to find.
      * @param start
-     *            the starting offset
-     * @return the index in this StringBuffer of the specified character, -1 if
-     *         the character isn't found
-     * 
+     *            the starting offset.
+     * @return the index of the specified character, -1 if the character isn't
+     *         found
      * @see #lastIndexOf(String,int)
-     * 
      * @since 1.4
      */
     public int indexOf(String subString, int start) {
@@ -727,19 +711,16 @@
     }
 
     /**
-     * Searches in this StringBuffer for the last index of the specified
-     * character. The search for the character starts at the end and moves
-     * towards the beginning.
+     * Searches for the last index of the specified character. The search for
+     * the character starts at the end and moves towards the beginning.
      * 
      * @param string
-     *            the string to find
-     * @return the index in this StringBuffer of the specified character, -1 if
-     *         the character isn't found
+     *            the string to find.
+     * @return the index of the specified character, -1 if the character isn't
+     *         found.
      * @throws NullPointerException
-     *             if the <code>string</code> parameter is <code>null</code>.
-     * 
+     *             if {@code string} is {@code null}.
      * @see String#lastIndexOf(java.lang.String)
-     * 
      * @since 1.4
      */
     public int lastIndexOf(String string) {
@@ -747,20 +728,18 @@
     }
 
     /**
-     * Searches in this StringBuffer for the index of the specified character.
-     * The search for the character starts at the specified offset and moves
-     * towards the beginning.
+     * Searches for the index of the specified character. The search for the
+     * character starts at the specified offset and moves towards the beginning.
      * 
      * @param subString
-     *            the string to find
+     *            the string to find.
      * @param start
-     *            the starting offset
-     * @return the index in this StringBuffer of the specified character, -1 if
-     *         the character isn't found
+     *            the starting offset.
+     * @return the index of the specified character, -1 if the character isn't
+     *         found.
      * @throws NullPointerException
-     *             if the <code>subString</code> parameter is
-     *             <code>null</code>.
-     * @see String#lastIndexOf(java.lang.String,int)
+     *             if {@code subString} is {@code null}.
+     * @see String#lastIndexOf(String,int)
      * @since 1.4
      */
     public int lastIndexOf(String subString, int start) {
@@ -817,15 +796,14 @@
     }
 
     /**
-     * Retrieves the Unicode code point value at the <code>index</code>.
+     * Retrieves the Unicode code point value at the {@code index}.
      * 
      * @param index
-     *            The index to the <code>char</code> code unit within this
-     *            object.
-     * @return The Unicode code point value.
+     *            the index to the {@code char} code unit.
+     * @return the Unicode code point value.
      * @throws IndexOutOfBoundsException
-     *             if <code>index</code> is negative or greater than or equal
-     *             to {@link #length()}.
+     *             if {@code index} is negative or greater than or equal to
+     *             {@link #length()}.
      * @see Character
      * @see Character#codePointAt(char[], int, int)
      * @since 1.5
@@ -838,15 +816,13 @@
     }
 
     /**
-     * Retrieves the Unicode code point value that precedes the
-     * <code>index</code>.
+     * Retrieves the Unicode code point value that precedes the {@code index}.
      * 
      * @param index
-     *            The index to the <code>char</code> code unit within this
-     *            object.
-     * @return The Unicode code point value.
+     *            the index to the {@code char} code unit within this object.
+     * @return the Unicode code point value.
      * @throws IndexOutOfBoundsException
-     *             if <code>index</code> is less than 1 or greater than
+     *             if {@code index} is less than 1 or greater than
      *             {@link #length()}.
      * @see Character
      * @see Character#codePointBefore(char[], int, int)
@@ -860,18 +836,20 @@
     }
 
     /**
-     * Calculates the number of Unicode code points between
-     * <code>beginIndex</code> and <code>endIndex</code>.
+     * Calculates the number of Unicode code points between {@code beginIndex}
+     * and {@code endIndex}.
      * 
      * @param beginIndex
-     *            The inclusive beginning index of the subsequence.
+     *            the inclusive beginning index of the subsequence.
      * @param endIndex
-     *            The exclusive end index of the subsequence.
-     * @return The number of Unicode code points in the subsequence.
+     *            the exclusive end index of the subsequence.
+     * @return the number of Unicode code points in the subsequence.
      * @throws IndexOutOfBoundsException
-     *             if <code>beginIndex</code> is negative or greater than
-     *             <code>endIndex</code> or <code>endIndex</code> is greater
-     *             than {@link #length()}.
+     *             if {@code beginIndex} is negative or greater than
+     *             {@code endIndex} or {@code endIndex} is greater than
+     *             {@link #length()}.
+     * @see Character
+     * @see Character#codePointCount(char[], int, int)
      * @since 1.5
      */
     public int codePointCount(int beginIndex, int endIndex) {
@@ -883,19 +861,22 @@
     }
 
     /**
-     * Returns the index within this object that is offset from
-     * <code>index</code> by <code>codePointOffset</code> code points.
-     * 
+     * Returns the index that is offset {@code codePointOffset} code points from
+     * {@code index}.
+     *
      * @param index
-     *            The index within this object to calculate the offset from.
+     *            the index to calculate the offset from.
      * @param codePointOffset
-     *            The number of code points to count.
-     * @return The index within this object that is the offset.
+     *            the number of code points to count.
+     * @return the index that is {@code codePointOffset} code points away from
+     *         index.
      * @throws IndexOutOfBoundsException
-     *             if <code>index</code> is negative or greater than
+     *             if {@code index} is negative or greater than
      *             {@link #length()} or if there aren't enough code points
-     *             before or after <code>index</code> to match
-     *             <code>codePointOffset</code>.
+     *             before or after {@code index} to match
+     *             {@code codePointOffset}.
+     * @see Character
+     * @see Character#offsetByCodePoints(char[], int, int, int, int)
      * @since 1.5
      */
     public int offsetByCodePoints(int index, int codePointOffset) {

Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Appendable.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Appendable.java?rev=770909&r1=770908&r2=770909&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Appendable.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Appendable.java Sat May  2 08:09:50 2009
@@ -19,83 +19,69 @@
 import java.io.IOException;
 
 /**
- * Appendable is an object used to append character or character sequence. Any
- * class implements this interface can receive data formatted by
- * <code>Formatter</code>. The appended character or character sequence
- * should be valid according to the rules described
- * <code>Unicode Character Representation</code>.
+ * Declares methods to append characters or character sequences. Any class that
+ * implements this interface can receive data formatted by a
+ * {@link java.util.Formatter}. The appended character or character sequence
+ * should be valid according to the rules described in
+ * {@link Character Unicode Character Representation}.
  * <p>
- * Appendable itself does not guarantee thread safety. This responsibility is up
- * to the implementing class.
- * </p>
+ * {@code Appendable} itself does not guarantee thread safety. This
+ * responsibility is up to the implementing class.
  * <p>
- * The implementing class can choose different exception handling mechanism. It
- * can choose to throw exceptions other than IOException but which must be
- * compatible with IOException, or does not throw any exceptions at all and use
- * error code instead. All in all, the implementing class does not guarantee to
- * propagate the exception declared by this interface.
- * </p>
+ * Implementing classes can choose different exception handling mechanism. They
+ * can choose to throw exceptions other than {@code IOException} or they do not
+ * throw any exceptions at all and use error codes instead.
  */
 public interface Appendable {
 
     /**
-     * Append the given character.
+     * Appends the specified character.
      * 
      * @param c
-     *            the character to append
-     * @return this <code>Appendable</code>
+     *            the character to append.
+     * @return this {@code Appendable}.
      * @throws IOException
-     *             if some I/O operation fails
+     *             if an I/O error occurs.
      */
     Appendable append(char c) throws IOException;
 
     /**
-     * Append the given <code>CharSequence</code>.
+     * Appends the character sequence {@code csq}. Implementation classes may
+     * not append the whole sequence, for example if the target is a buffer with
+     * limited size.
      * <p>
-     * The behaviour of this method depends on the implementation class of
-     * <code>Appendable</code>.
-     * </p>
-     * <p>
-     * If the give <code>CharSequence</code> is null, the sequence is treated
-     * as String "null".
-     * </p>
-     * 
+     * If {@code csq} is {@code null}, the characters "null" are appended.
+     *
      * @param csq
-     *            the <code>CharSequence</code> to be append
-     * @return this <code>Appendable</code>
+     *            the character sequence to append.
+     * @return this {@code Appendable}.
      * @throws IOException
-     *             if some I/O operation fails
+     *             if an I/O error occurs.
      */
     Appendable append(CharSequence csq) throws IOException;
 
     /**
-     * Append part of the given <code>CharSequence</code>.
-     * 
-     * If the given <code>CharSequence</code> is not null, this method behaves
-     * same as the following statement:
-     * 
-     * <pre>
-     * out.append(csq.subSequence(start, end))
-     * </pre>
-     * 
-     * If the give <code>CharSequence</code> is null, the sequence is treated
-     * as String "null".
+     * Appends a subsequence of {@code csq}.
+     * <p>
+     * If {@code csq} is not {@code null} then calling this method is equivalent
+     * to calling {@code append(csq.subSequence(start, end))}.
+     * <p>
+     * If {@code csq} is {@code null}, the characters "null" are appended.
      * 
      * @param csq
-     *            the <code>CharSequence</code> to be append
+     *            the character sequence to append.
      * @param start
-     *            the index to specify the start position of
-     *            <code>CharSequence</code> to be append, must be
-     *            non-negative, and not larger than the <code>end</code>
+     *            the first index of the subsequence of {@code csq} that is
+     *            appended.
      * @param end
-     *            the index to specify the end position of
-     *            <code>CharSequence</code> to be append, must be
-     *            non-negative, and not larger than the size of <code>csq</code>
-     * @return this <code>Appendable</code>
-     * @throws IOException
-     *             if some I/O operation fails
+     *            the last index of the subsequence of {@code csq} that is
+     *            appended.
+     * @return this {@code Appendable}.
      * @throws IndexOutOfBoundsException
-     *             if the start or end is illegal
+     *             if {@code start < 0}, {@code end < 0}, {@code start > end}
+     *             or {@code end} is greater than the length of {@code csq}.
+     * @throws IOException
+     *             if an I/O error occurs.
      */
     Appendable append(CharSequence csq, int start, int end) throws IOException;
 }

Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ArithmeticException.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ArithmeticException.java?rev=770909&r1=770908&r2=770909&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ArithmeticException.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ArithmeticException.java Sat May  2 08:09:50 2009
@@ -18,26 +18,26 @@
 package java.lang;
 
 /**
- * This runtime exception is thrown when the an invalid arithmetic operation is
- * attempted.
+ * Thrown when the an invalid arithmetic operation is attempted.
  */
 public class ArithmeticException extends RuntimeException {
 
     private static final long serialVersionUID = 2256477558314496007L;
 
     /**
-     * Constructs a new instance of this class with its walkback filled in.
+     * Constructs a new {@code ArithmeticException} that includes the current
+     * stack trace.
      */
     public ArithmeticException() {
         super();
     }
 
     /**
-     * Constructs a new instance of this class with its walkback and message
-     * filled in.
-     * 
+     * Constructs a new {@code ArithmeticException} with the current stack trace
+     * and the specified detail message.
+     *
      * @param detailMessage
-     *            String The detail message for the exception.
+     *            the detail message for this exception.
      */
     public ArithmeticException(String detailMessage) {
         super(detailMessage);

Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ArrayIndexOutOfBoundsException.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ArrayIndexOutOfBoundsException.java?rev=770909&r1=770908&r2=770909&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ArrayIndexOutOfBoundsException.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ArrayIndexOutOfBoundsException.java Sat May  2 08:09:50 2009
@@ -20,38 +20,39 @@
 import org.apache.harmony.luni.util.Msg;
 
 /**
- * This runtime exception is thrown when the an array is indexed with a value
- * less than zero, or greater than or equal to the size of the array.
+ * Thrown when the an array is indexed with a value less than zero, or greater
+ * than or equal to the size of the array.
  */
 public class ArrayIndexOutOfBoundsException extends IndexOutOfBoundsException {
 
     private static final long serialVersionUID = -5116101128118950844L;
 
     /**
-     * Constructs a new instance of this class with its walkback filled in.
+     * Constructs a new {@code ArrayIndexOutOfBoundsException} that includes the
+     * current stack trace.
      */
     public ArrayIndexOutOfBoundsException() {
         super();
     }
 
     /**
-     * Constructs a new instance of this class with its walkback and message
-     * (which is based on the argument which is the index which failed) filled
-     * in.
+     * Constructs a new {@code ArrayIndexOutOfBoundsException} with the current
+     * stack trace and a detail message that is based on the specified invalid
+     * {@code index}.
      * 
      * @param index
-     *            int the offending index.
+     *            the invalid index.
      */
     public ArrayIndexOutOfBoundsException(int index) {
         super(Msg.getString("K0052", index)); //$NON-NLS-1$
     }
 
     /**
-     * Constructs a new instance of this class with its walkback and message
-     * filled in.
-     * 
+     * Constructs a new {@code ArrayIndexOutOfBoundsException} with the current
+     * stack trace and the specified detail message.
+     *
      * @param detailMessage
-     *            String The detail message for the exception.
+     *            the detail message for this exception.
      */
     public ArrayIndexOutOfBoundsException(String detailMessage) {
         super(detailMessage);

Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ArrayStoreException.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ArrayStoreException.java?rev=770909&r1=770908&r2=770909&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ArrayStoreException.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/ArrayStoreException.java Sat May  2 08:09:50 2009
@@ -18,26 +18,27 @@
 package java.lang;
 
 /**
- * This runtime exception is thrown when a program attempts to store into an
- * array an element of a a type which the array can not hold..
+ * Thrown when a program attempts to store an element of an incompatible type in
+ * an array.
  */
 public class ArrayStoreException extends RuntimeException {
 
     private static final long serialVersionUID = -4522193890499838241L;
 
     /**
-     * Constructs a new instance of this class with its walkback filled in.
+     * Constructs a new {@code ArrayStoreException} that includes the current
+     * stack trace.
      */
     public ArrayStoreException() {
         super();
     }
 
     /**
-     * Constructs a new instance of this class with its walkback and message
-     * filled in.
-     * 
+     * Constructs a new {@code ArrayStoreException} with the current stack trace
+     * and the specified detail message.
+     *
      * @param detailMessage
-     *            String The detail message for the exception.
+     *            the detail message for this exception.
      */
     public ArrayStoreException(String detailMessage) {
         super(detailMessage);

Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AssertionError.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AssertionError.java?rev=770909&r1=770908&r2=770909&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AssertionError.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/AssertionError.java Sat May  2 08:09:50 2009
@@ -18,8 +18,8 @@
 package java.lang;
 
 /**
- * Indicates that an assertion has failed.
- * 
+ * Thrown when an assertion has failed.
+ *
  * @since 1.4
  */
 public class AssertionError extends Error {
@@ -27,21 +27,21 @@
     private static final long serialVersionUID = -5013299493970297370L;
 
     /**
-     * Constructs an instance without a message.
+     * Constructs a new {@code AssertionError} with no message.
      */
     public AssertionError() {
         super();
     }
 
     /**
-     * Constructs an instance with a message that is the
-     * {@link String#valueOf(Object)} of the object passed. If the object passed
+     * Constructs a new {@code AssertionError} with a message based on calling
+     * {@link String#valueOf(Object)} with the specified object. If the object
      * is an instance of {@link Throwable}, then it also becomes the cause of
      * this error.
      * 
      * @param detailMessage
-     *            The value to be converted into the message and optionally the
-     *            cause.
+     *            the object to be converted into the detail message and
+     *            optionally the cause.
      */
     public AssertionError(Object detailMessage) {
         super(String.valueOf(detailMessage),
@@ -50,66 +50,66 @@
     }
 
     /**
-     * Constructs an instance with a message that is the
-     * {@link String#valueOf(boolean)} of the boolean passed.
+     * Constructs a new {@code AssertionError} with a message based on calling
+     * {@link String#valueOf(boolean)} with the specified boolean value.
      * 
      * @param detailMessage
-     *            The value to be converted into the message.
+     *            the value to be converted into the message.
      */
     public AssertionError(boolean detailMessage) {
         this(String.valueOf(detailMessage));
     }
 
     /**
-     * Constructs an instance with a message that is the
-     * {@link String#valueOf(char)} of the char passed.
+     * Constructs a new {@code AssertionError} with a message based on calling
+     * {@link String#valueOf(char)} with the specified character value.
      * 
      * @param detailMessage
-     *            The value to be converted into the message.
+     *            the value to be converted into the message.
      */
     public AssertionError(char detailMessage) {
         this(String.valueOf(detailMessage));
     }
 
     /**
-     * Constructs an instance with a message that is the
-     * {@link String#valueOf(int)} of the int passed.
+     * Constructs a new {@code AssertionError} with a message based on calling
+     * {@link String#valueOf(int)} with the specified integer value.
      * 
      * @param detailMessage
-     *            The value to be converted into the message.
+     *            the value to be converted into the message.
      */
     public AssertionError(int detailMessage) {
         this(Integer.toString(detailMessage));
     }
 
     /**
-     * Constructs an instance with a message that is the
-     * {@link String#valueOf(long)} of the long passed.
+     * Constructs a new {@code AssertionError} with a message based on calling
+     * {@link String#valueOf(long)} with the specified long value.
      * 
      * @param detailMessage
-     *            The value to be converted into the message.
+     *            the value to be converted into the message.
      */
     public AssertionError(long detailMessage) {
         this(Long.toString(detailMessage));
     }
 
     /**
-     * Constructs an instance with a message that is the
-     * {@link String#valueOf(float)} of the float passed.
+     * Constructs a new {@code AssertionError} with a message based on calling
+     * {@link String#valueOf(float)} with the specified float value.
      * 
      * @param detailMessage
-     *            The value to be converted into the message.
+     *            the value to be converted into the message.
      */
     public AssertionError(float detailMessage) {
         this(Float.toString(detailMessage));
     }
 
     /**
-     * Constructs an instance with a message that is the
-     * {@link String#valueOf(double)} of the double passed.
+     * Constructs a new {@code AssertionError} with a message based on calling
+     * {@link String#valueOf(double)} with the specified double value.
      * 
      * @param detailMessage
-     *            The value to be converted into the message.
+     *            the value to be converted into the message.
      */
     public AssertionError(double detailMessage) {
         this(Double.toString(detailMessage));

Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Boolean.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Boolean.java?rev=770909&r1=770908&r2=770909&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Boolean.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Boolean.java Sat May  2 08:09:50 2009
@@ -20,8 +20,8 @@
 import java.io.Serializable;
 
 /**
- * Boolean is the wrapper for the primitive type <code>boolean</code>.
- * 
+ * The wrapper for the primitive type {@code boolean}.
+ *
  * @since 1.0
  */
 public final class Boolean implements Serializable, Comparable<Boolean> {
@@ -34,7 +34,8 @@
     private final boolean value;
 
     /**
-     * The {@link java.lang.Class} that represents this class.
+     * The {@link Class} object that represents the primitive type {@code
+     * boolean}.
      */
     @SuppressWarnings("unchecked")
     public static final Class<Boolean> TYPE = (Class<Boolean>) new boolean[0]
@@ -44,63 +45,61 @@
     // defined to be "java.lang.Boolean.TYPE";
 
     /**
-     * The instance of the receiver which represents truth.
+     * The {@code Boolean} object that represents the primitive value
+     * {@code true}.
      */
     public static final Boolean TRUE = new Boolean(true);
 
     /**
-     * The instance of the receiver which represents falsehood.
+     * The {@code Boolean} object that represents the primitive value
+     * {@code false}.
      */
     public static final Boolean FALSE = new Boolean(false);
 
     /**
-     * Constructs a new instance of this class given a string. If the string is
-     * equal to "true" using a non-case sensitive comparison, the result will be
-     * a Boolean representing true, otherwise it will be a Boolean representing
-     * false.
+     * Constructs a new {@code Boolean} with its boolean value specified by
+     * {@code string}. If {@code string} is not {@code null} and is equal to
+     * "true" using a non-case sensitive comparison, the result will be a
+     * Boolean representing the primitive value {@code true}, otherwise it will
+     * be a Boolean representing the primitive value {@code false}.
      * 
      * @param string
-     *            The name of the desired boolean.
+     *            the string representing a boolean value.
      */
     public Boolean(String string) {
         this(parseBoolean(string));
     }
 
     /**
-     * Constructs a new instance of this class given true or false.
+     * Constructs a new {@code Boolean} with the specified primitive boolean
+     * value.
      * 
      * @param value
-     *            true or false.
+     *            the primitive boolean value, {@code true} or {@code false}.
      */
     public Boolean(boolean value) {
         this.value = value;
     }
 
     /**
-     * Answers true if the receiver represents true and false if the receiver
-     * represents false.
+     * Gets the primitive value of this boolean, either {@code true} or
+     * {@code false}.
      * 
-     * @return true or false.
+     * @return this object's primitive value, {@code true} or {@code false}.
      */
     public boolean booleanValue() {
         return value;
     }
 
     /**
-     * Compares the argument to the receiver, and answers true if they represent
-     * the <em>same</em> object using a class specific comparison.
-     * <p>
-     * In this case, the argument must also be a Boolean, and the receiver and
-     * argument must represent the same boolean value (i.e. both true or both
-     * false).
-     * </p>
+     * Compares this instance with the specified object and indicates if they
+     * are equal. In order to be equal, {@code o} must be an instance of
+     * {@code Boolean} and have the same boolean value as this object.
      * 
      * @param o
-     *            the object to compare with this object
-     * @return <code>true</code> if the object is the same as this object
-     *         <code>false</code> if it is different from this object
-     * 
-     * @see #hashCode
+     *            the object to compare this boolean with.
+     * @return {@code true} if the specified object is equal to this
+     *         {@code Boolean}; {@code false} otherwise.
      */
     @Override
     public boolean equals(Object o) {
@@ -109,19 +108,18 @@
     }
 
     /**
-     * Compares this <code>Boolean</code> to another <code>Boolean</code>.
-     * If this instance has the same value as the instance passed, then
-     * <code>0</code> is returned. If this instance is <code>true</code> and
-     * the instance passed is <code>false</code>, then a positive value is
-     * returned. If this instance is <code>false</code> and the instance
-     * passed is <code>true</code>, then a negative value is returned.
+     * Compares this object to the specified boolean object to determine their
+     * relative order.
      * 
      * @param that
-     *            The instance to compare to.
-     * @throws NullPointerException
-     *             if <code>that</code> is <code>null</code>.
-     * @since 1.5
+     *            the boolean object to compare this object to.
+     * @return 0 if the value of this boolean and the value of {@code that} are
+     *         equal; a positive value if the value of this boolean is
+     *         {@code true} and the value of {@code that} is {@code false}; a
+     *         negative value if the value if this boolean is {@code false} and
+     *         the value of {@code that} is {@code true}.
      * @see java.lang.Comparable
+     * @since 1.5
      */
     public int compareTo(Boolean that) {
         if (that == null) {
@@ -136,12 +134,10 @@
     }
 
     /**
-     * Answers an integer hash code for the receiver. Any two objects which
-     * answer <code>true</code> when passed to <code>equals</code> must
-     * answer the same value for this method.
+     * Returns an integer hash code for this boolean.
      * 
-     * @return the receiver's hash
-     * @see #equals
+     * @return this boolean's hash code, which is {@code 1231} for {@code true}
+     *         values and {@code 1237} for {@code false} values.
      */
     @Override
     public int hashCode() {
@@ -149,10 +145,11 @@
     }
 
     /**
-     * Answers a string containing a concise, human-readable description of the
-     * receiver.
+     * Returns a string containing a concise, human-readable description of this
+     * boolean.
      * 
-     * @return a printable representation for the receiver.
+     * @return "true" if the value of this boolean is {@code true}, "false"
+     *         otherwise.
      */
     @Override
     public String toString() {
@@ -160,12 +157,15 @@
     }
 
     /**
-     * Answers true if the system property described by the argument equal to
-     * "true" using case insensitive comparison, and false otherwise.
+     * Returns the {@code boolean} value of the system property identified by
+     * {@code string}.
      * 
      * @param string
-     *            The name of the desired boolean.
-     * @return The boolean value.
+     *            the name of the requested system property.
+     * @return {@code true} if the system property named by {@code string}
+     *         exists and it is equal to "true" using case insensitive
+     *         comparison, {@code false} otherwise.
+     * @see System#getProperty(String)
      */
     public static boolean getBoolean(String string) {
         if (string == null || string.length() == 0) {
@@ -175,13 +175,13 @@
     }
 
     /**
-     * Parses the string as a <code>boolean</code>. If the string is not
-     * <code>null</code> and is equal to <code>"true"</code>, regardless
-     * case, then <code>true</code> is returned, otherwise <code>false</code>.
+     * Parses the specified string as a {@code boolean}.
      * 
      * @param s
-     *            The string to parse.
-     * @return A boolean value.
+     *            the string representation of a boolean value.
+     * @return {@code true} if {@code s} is not {@code null} and is equal to
+     *         {@code "true"} using case insensitive comparison, {@code false}
+     *         otherwise.
      * @since 1.5
      */
     public static boolean parseBoolean(String s) {
@@ -189,38 +189,40 @@
     }
 
     /**
-     * Converts the specified boolean to its string representation. When the
-     * boolean is true answer <code>"true"</code>, otherwise answer
-     * <code>"false"</code>.
+     * Converts the specified boolean to its string representation.
      * 
      * @param value
-     *            the boolean
-     * @return the boolean converted to a string
+     *            the boolean to convert.
+     * @return "true" if {@code value} is {@code true}, "false" otherwise.
      */
     public static String toString(boolean value) {
         return String.valueOf(value);
     }
 
     /**
-     * Answers a Boolean representing true if the argument is equal to "true"
-     * using case insensitive comparison, and a Boolean representing false
-     * otherwise.
+     * Parses the specified string as a boolean value.
      * 
      * @param string
-     *            The name of the desired boolean.
-     * @return the boolean value.
+     *            the string representation of a boolean value.
+     * @return {@code Boolean.TRUE} if {@code string} is equal to "true" using
+     *         case insensitive comparison, {@code Boolean.FALSE} otherwise.
+     * @see #parseBoolean(String)
      */
     public static Boolean valueOf(String string) {
         return parseBoolean(string) ? Boolean.TRUE : Boolean.FALSE;
     }
 
     /**
-     * Answers Boolean.TRUE if the argument is equal to "true" using case
-     * insensitive comparison, and Boolean.FALSE representing false otherwise.
-     * 
+     * Returns a {@code Boolean} instance for the specified boolean value.
+     * <p>
+     * If it is not necessary to get a new {@code Boolean} instance, it is
+     * recommended to use this method instead of the constructor, since it
+     * returns its static instances, which results in better performance.
+     *
      * @param b
-     *            the boolean value.
-     * @return Boolean.TRUE or Boolean.FALSE Global true/false objects.
+     *            the boolean to convert to a {@code Boolean}.
+     * @return {@code Boolean.TRUE} if {@code b} is equal to {@code true},
+     *         {@code Boolean.FALSE} otherwise.
      */
     public static Boolean valueOf(boolean b) {
         return b ? Boolean.TRUE : Boolean.FALSE;

Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Byte.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Byte.java?rev=770909&r1=770908&r2=770909&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Byte.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Byte.java Sat May  2 08:09:50 2009
@@ -18,8 +18,8 @@
 package java.lang;
 
 /**
- * Byte is the wrapper for the primitive type <code>byte</code>.
- * 
+ * The wrapper for the primitive type {@code byte}.
+ *
  * @since 1.1
  */
 public final class Byte extends Number implements Comparable<Byte> {
@@ -32,25 +32,25 @@
     private final byte value;
 
     /**
-     * Constant for the maximum <code>byte</code> value, 2<sup>7</sup>-1.
+     * The maximum {@code Byte} value, 2<sup>7</sup>-1.
      */
     public static final byte MAX_VALUE = (byte) 0x7F;
 
     /**
-     * Constant for the minimum <code>byte</code> value, -2<sup>7</sup>.
+     * The minimum {@code Byte} value, -2<sup>7</sup>.
      */
     public static final byte MIN_VALUE = (byte) 0x80;
 
     /**
-     * Constant for the number of bits to represent a <code>byte</code> in
-     * two's compliment form.
+     * The number of bits needed to represent a {@code Byte} value in two's
+     * complement form.
      * 
      * @since 1.5
      */
     public static final int SIZE = 8;
 
     /**
-     * The java.lang.Class that represents this class.
+     * The {@link Class} object that represents the primitive type {@code byte}.
      */
     @SuppressWarnings("unchecked")
     public static final Class<Byte> TYPE = (Class<Byte>) new byte[0].getClass()
@@ -65,32 +65,32 @@
     private static final Byte[] CACHE = new Byte[256];
 
     /**
-     * Constructs a new instance of the receiver which represents the byte
-     * valued argument.
+     * Constructs a new {@code Byte} with the specified primitive byte value.
      * 
      * @param value
-     *            the byte to store in the new instance.
+     *            the primitive byte value to store in the new instance.
      */
     public Byte(byte value) {
         this.value = value;
     }
 
     /**
-     * Constructs a new instance of this class given a string.
+     * Constructs a new {@code Byte} from the specified string.
      * 
      * @param string
-     *            a string representation of a single byte quantity.
+     *            the string representation of a single byte value.
      * @throws NumberFormatException
-     *             if the argument could not be parsed as a byte quantity.
+     *             if {@code string} can not be decoded into a byte value.
+     * @see #parseByte(String)
      */
     public Byte(String string) throws NumberFormatException {
         this(parseByte(string));
     }
 
     /**
-     * Answers the byte value which the receiver represents
+     * Gets the primitive value of this byte.
      * 
-     * @return byte the value of the receiver.
+     * @return this object's primitive value.
      */
     @Override
     public byte byteValue() {
@@ -98,17 +98,16 @@
     }
 
     /**
-     * Compares this <code>Byte</code> to the <code>Byte</code> passed. If
-     * this instance's value is equal to the value of the instance passed, then
-     * 0 is returned. If this instance's value is less than the value of the
-     * instance passed, then a negative value is returned. If this instance's
-     * value is greater than the value of the instance passed, then a positive
-     * value is returned.
+     * Compares this object to the specified byte object to determine their
+     * relative order.
      * 
      * @param object
-     *            The instance to compare to.
-     * @throws NullPointerException
-     *             if <code>object</code> is <code>null</code>.
+     *            the byte object to compare this object to.
+     * @return a negative value if the value of this byte is less than the value
+     *         of {@code object}; 0 if the value of this byte and the value of
+     *         {@code object} are equal; a positive value if the value of this
+     *         byte is greater than the value of {@code object}.
+     * @see java.lang.Comparable
      * @since 1.2
      */
     public int compareTo(Byte object) {
@@ -116,16 +115,16 @@
     }
 
     /**
-     * Parses the string argument as if it was a byte value and returns the
-     * result. It is an error if the received string does not contain a
-     * representation of a single byte quantity. The string may be a hexadecimal
-     * ("0x..."), octal ("0..."), or decimal ("...") representation of a byte.
+     * Parses the specified string and returns a {@code Byte} instance if the
+     * string can be decoded into a single byte value. The string may be an
+     * optional minus sign "-" followed by a hexadecimal ("0x..." or "#..."),
+     * octal ("0..."), or decimal ("...") representation of a byte.
      * 
      * @param string
-     *            a string representation of a single byte quantity.
-     * @return Byte the value represented by the argument
+     *            a string representation of a single byte value.
+     * @return a {@code Byte} containing the value represented by {@code string}.
      * @throws NumberFormatException
-     *             if the argument could not be parsed as a byte quantity.
+     *             if {@code string} can not be parsed as a byte value.
      */
     public static Byte decode(String string) throws NumberFormatException {
         int intValue = Integer.decode(string).intValue();
@@ -136,29 +135,20 @@
         throw new NumberFormatException();
     }
 
-    /**
-     * Answers the double value which the receiver represents
-     * 
-     * @return double the value of the receiver.
-     */
     @Override
     public double doubleValue() {
         return value;
     }
 
     /**
-     * Compares the argument to the receiver, and answers true if they represent
-     * the <em>same</em> object using a class specific comparison.
-     * <p>
-     * In this case, the argument must also be a Byte, and the receiver and
-     * argument must represent the same byte value.
-     * </p>
+     * Compares this object with the specified object and indicates if they are
+     * equal. In order to be equal, {@code object} must be an instance of
+     * {@code Byte} and have the same byte value as this object.
      * 
      * @param object
-     *            the object to compare with this object
-     * @return <code>true</code> if the object is the same as this object
-     *         <code>false</code> if it is different from this object
-     * @see #hashCode
+     *            the object to compare this byte with.
+     * @return {@code true} if the specified object is equal to this
+     *         {@code Byte}; {@code false} otherwise.
      */
     @Override
     public boolean equals(Object object) {
@@ -166,59 +156,36 @@
                 && (value == ((Byte) object).value);
     }
 
-    /**
-     * Answers the float value which the receiver represents
-     * 
-     * @return float the value of the receiver.
-     */
     @Override
     public float floatValue() {
         return value;
     }
 
-    /**
-     * Answers an integer hash code for the receiver. Any two objects which
-     * answer <code>true</code> when passed to <code>equals</code> must
-     * answer the same value for this method.
-     * 
-     * @return the receiver's hash
-     * @see #equals
-     */
     @Override
     public int hashCode() {
         return value;
     }
 
-    /**
-     * Answers the int value which the receiver represents
-     * 
-     * @return int the value of the receiver.
-     */
     @Override
     public int intValue() {
         return value;
     }
 
-    /**
-     * Answers the long value which the receiver represents
-     * 
-     * @return long the value of the receiver.
-     */
     @Override
     public long longValue() {
         return value;
     }
 
     /**
-     * Parses the string argument as if it was a byte value and returns the
-     * result. Throws NumberFormatException if the string does not represent a
-     * single byte quantity.
+     * Parses the specified string as a signed decimal byte value. The ASCII
+     * character \u002d ('-') is recognized as the minus sign.
      * 
      * @param string
-     *            a string representation of a single byte quantity.
-     * @return byte the value represented by the argument
+     *            the string representation of a single byte value.
+     * @return the primitive byte value represented by {@code string}.
      * @throws NumberFormatException
-     *             if the argument could not be parsed as a byte quantity.
+     *             if {@code string} is {@code null}, has a length of zero or
+     *             can not be parsed as a byte value.
      */
     public static byte parseByte(String string) throws NumberFormatException {
         int intValue = Integer.parseInt(string);
@@ -230,18 +197,20 @@
     }
 
     /**
-     * Parses the string argument as if it was a byte value and returns the
-     * result. Throws NumberFormatException if the string does not represent a
-     * single byte quantity. The second argument specifies the radix to use when
-     * parsing the value.
+     * Parses the specified string as a signed byte value using the specified
+     * radix. The ASCII character \u002d ('-') is recognized as the minus sign.
      * 
      * @param string
-     *            a string representation of a single byte quantity.
+     *            the string representation of a single byte value.
      * @param radix
      *            the radix to use when parsing.
-     * @return byte the value represented by the argument
+     * @return the primitive byte value represented by {@code string} using
+     *         {@code radix}.
      * @throws NumberFormatException
-     *             if the argument could not be parsed as a byte quantity.
+     *             if {@code string} is {@code null} or has a length of zero,
+     *             {@code radix < Character.MIN_RADIX},
+     *             {@code radix > Character.MAX_RADIX}, or if {@code string}
+     *             can not be parsed as a byte value.
      */
     public static byte parseByte(String string, int radix)
             throws NumberFormatException {
@@ -253,67 +222,60 @@
         throw new NumberFormatException();
     }
 
-    /**
-     * Answers the short value which the receiver represents
-     * 
-     * @return short the value of the receiver.
-     */
     @Override
     public short shortValue() {
         return value;
     }
 
-    /**
-     * Answers a string containing a concise, human-readable description of the
-     * receiver.
-     * 
-     * @return a printable representation for the receiver.
-     */
     @Override
     public String toString() {
         return Integer.toString(value);
     }
 
     /**
-     * Answers a string containing a concise, human-readable description of the
-     * argument.
+     * Returns a string containing a concise, human-readable description of the
+     * specified byte value.
      * 
      * @param value
-     *            byte the byte to convert.
-     * @return String a printable representation for the byte.
+     *            the byte to convert to a string.
+     * @return a printable representation of {@code value}.
      */
     public static String toString(byte value) {
         return Integer.toString(value);
     }
 
     /**
-     * Parses the string argument as if it was a byte value and returns a Byte
-     * representing the result. Throws NumberFormatException if the string
-     * cannot be parsed as a byte quantity.
+     * Parses the specified string as a signed decimal byte value.
      * 
      * @param string
-     *            a string representation of a single byte quantity.
-     * @return Byte the value represented by the argument
+     *            the string representation of a single byte value.
+     * @return a {@code Byte} instance containing the byte value represented by
+     *         {@code string}.
      * @throws NumberFormatException
-     *             if the argument could not be parsed as a byte quantity.
+     *             if {@code string} is {@code null}, has a length of zero or
+     *             can not be parsed as a byte value.
+     * @see #parseByte(String)
      */
     public static Byte valueOf(String string) throws NumberFormatException {
         return valueOf(parseByte(string));
     }
 
     /**
-     * Parses the string argument as if it was a byte value and returns a Byte
-     * representing the result. Throws NumberFormatException if the string
-     * cannot be parsed as a byte quantity. The second argument specifies the
-     * radix to use when parsing the value.
+     * Parses the specified string as a signed byte value using the specified
+     * radix.
      * 
      * @param string
-     *            a string representation of a single byte quantity.
+     *            the string representation of a single byte value.
      * @param radix
      *            the radix to use when parsing.
-     * @return Byte the value represented by the argument
+     * @return a {@code Byte} instance containing the byte value represented by
+     *         {@code string} using {@code radix}.
      * @throws NumberFormatException
-     *             if the argument could not be parsed as a byte quantity.
+     *             if {@code string} is {@code null} or has a length of zero,
+     *             {@code radix < Character.MIN_RADIX},
+     *             {@code radix > Character.MAX_RADIX}, or if {@code string}
+     *             can not be parsed as a byte value.
+     * @see #parseByte(String, int)
      */
     public static Byte valueOf(String string, int radix)
             throws NumberFormatException {
@@ -321,13 +283,15 @@
     }
 
     /**
-     * Returns a <code>Byte</code> instance for the <code>byte</code> value
-     * passed. This method is preferred over the constructor, as this method may
-     * maintain a cache of instances.
+     * Returns a {@code Byte} instance for the specified byte value.
+     * <p>
+     * If it is not necessary to get a new {@code Byte} instance, it is
+     * recommended to use this method instead of the constructor, since it
+     * maintains a cache of instances which may result in better performance.
      * 
      * @param b
-     *            The byte value.
-     * @return A <code>Byte</code> instance.
+     *            the byte value to store in the instance.
+     * @return a {@code Byte} instance containing {@code b}.
      * @since 1.5
      */
     public static Byte valueOf(byte b) {

Modified: harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/CharSequence.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/CharSequence.java?rev=770909&r1=770908&r2=770909&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/CharSequence.java (original)
+++ harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/CharSequence.java Sat May  2 08:09:50 2009
@@ -19,48 +19,56 @@
 
 
 /**
- * The CharSequence interface represents an ordered set of characters and the
- * functions to probe them.
+ * This interface represents an ordered set of characters and defines the
+ * methods to probe them.
  */
 public interface CharSequence {
 
-	/**
-	 * Answers the number of characters in the sequence.
-	 * 
-	 * @return the number of characters in the sequence
-	 */
-	public int length();
-
-	/**
-	 * Answers the character at the specified index (0-based indexing).
-	 * 
-	 * @param index -
-	 *            of the character to return
-	 * @return character indicated by index
-	 * @throws IndexOutOfBoundsException
-	 *             when <code>index &lt 0</code> or
-	 *             <code>index</code> &gt= the length of the <code>CharSequence</code>
-	 */
-	public char charAt(int index);
-
-	/**
-	 * Answers a CharSequence from the <code>start</code> index to the
-	 * <code>end</code> index of this sequence.
-	 *
-	 * @param		start -- index of the start of the sub-sequence to return
-	 * @param		end -- index of the end of the sub-sequence to return
-	 * @return		the sub sequence from start to end
-	 * @throws		IndexOutOfBoundsException when 1. either index is below 0
-	 * 				2. either index >= <code>this.length()</code>
-	 * 				3. <code>start > end </code>
-	 */
-	public CharSequence subSequence(int start, int end);
-
-	/**
-	 * Answers a String with the same characters and ordering of this
-	 * CharSequence
-	 * 
-	 * @return a String based on the CharSequence
-	 */
-	public String toString();
+    /**
+     * Returns the number of characters in this sequence.
+     * 
+     * @return the number of characters.
+     */
+    public int length();
+
+    /**
+     * Returns the character at the specified index, with the first character
+     * having index zero.
+     * 
+     * @param index
+     *            the index of the character to return.
+     * @return the requested character.
+     * @throws IndexOutOfBoundsException
+     *             if {@code index < 0} or {@code index} is greater than the
+     *             length of this sequence.
+     */
+    public char charAt(int index);
+
+    /**
+     * Returns a {@code CharSequence} from the {@code start} index (inclusive)
+     * to the {@code end} index (exclusive) of this sequence.
+     * 
+     * @param start
+     *            the start offset of the sub-sequence. It is inclusive, that
+     *            is, the index of the first character that is included in the
+     *            sub-sequence.
+     * @param end
+     *            the end offset of the sub-sequence. It is exclusive, that is,
+     *            the index of the first character after those that are included
+     *            in the sub-sequence
+     * @return the requested sub-sequence.
+     * @throws IndexOutOfBoundsException
+     *             if {@code start < 0}, {@code end < 0}, {@code start > end},
+     *             or if {@code start} or {@code end} are greater than the
+     *             length of this sequence.
+     */
+    public CharSequence subSequence(int start, int end);
+
+    /**
+     * Returns a string with the same characters in the same order as in this
+     * sequence.
+     * 
+     * @return a string based on this sequence.
+     */
+    public String toString();
 }



Mime
View raw message