Class Javadoc: Normalize the first sentence and some @see's and {@link}s

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@137654 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/commons/lang/builder/CompareToBuilder.java

@@ -61,10 +61,9 @@ import java.util.Comparator;
 import org.apache.commons.lang.math.NumberUtils;
 
 /** 
- * <p><code>CompareTo</code> generation routines.</p>
+ * Assists in implementing {@link java.lang.Comparable#compareTo(Object)} methods.
  *
- * <p>This class provides methods to assist in building a quality
- * <code>compareTo(Object)</code>.  It is consistent with <code>equals(Object)</code> and
+ * It is consistent with <code>equals(Object)</code> and
  * <code>hashcode()</code> built with {@link EqualsBuilder} and
  * {@link HashCodeBuilder}.</p>
  *
@@ -100,7 +99,7 @@ import org.apache.commons.lang.math.NumberUtils;
  *
  * <p>Alternatively, there is a method {@link #reflectionCompare reflectionCompare} that uses
  * reflection to determine the fields to append. Because fields can be private,
- * <code>reflectionCompare</code> uses <code>AccessibleObject.setAccessible</code> to
+ * <code>reflectionCompare</code> uses {@link java.lang.reflect.AccessibleObject#setAccessible(boolean)} to
  * bypass normal access control checks. This will fail under a security manager,
  * unless the appropriate permissions are set up correctly. It is also
  * slower than appending explicitly.</p>
@@ -114,12 +113,17 @@ import org.apache.commons.lang.math.NumberUtils;
  * }
  * </pre>
  *
+ * @see java.lang.Comparable
+ * @see java.lang.Object#equals(Object)
+ * @see java.lang.Object#hashCode()
+ * @see EqualsBuilder
+ * @see HashCodeBuilder
  * @author <a href="mailto:steve.downey@netfolio.com">Steve Downey</a>
  * @author Stephen Colebourne
  * @author Gary Gregory
  * @author Pete Gieser
  * @since 1.0
- * @version $Id: CompareToBuilder.java,v 1.22 2003/08/21 15:13:09 ggregory Exp $
+ * @version $Id: CompareToBuilder.java,v 1.23 2003/08/23 00:21:49 ggregory Exp $
  */
 public class CompareToBuilder {
     

src/java/org/apache/commons/lang/builder/EqualsBuilder.java

@@ -58,7 +58,7 @@ import java.lang.reflect.Field;
 import java.lang.reflect.Modifier;
 
 /**
- * <p><code>Equals</code> generation routines.</p>
+ * <p>Assists in implementing {@link Object#equals(Object)} methods.</p>
  *
  * <p> This class provides methods to build a good equals method for any
  * class. It follows rules laid out in
@@ -111,7 +111,7 @@ import java.lang.reflect.Modifier;
  * @author Gary Gregory
  * @author Pete Gieser
  * @since 1.0
- * @version $Id: EqualsBuilder.java,v 1.19 2003/08/21 15:52:54 ggregory Exp $
+ * @version $Id: EqualsBuilder.java,v 1.20 2003/08/23 00:21:49 ggregory Exp $
  */
 public class EqualsBuilder {
     /**

src/java/org/apache/commons/lang/builder/HashCodeBuilder.java

@@ -58,7 +58,7 @@ import java.lang.reflect.Field;
 import java.lang.reflect.Modifier;
 
 /**
- * <p><code>HashCode</code> generation routines.</p>
+ * <p>Assists in implementing {@link Object#hashCode()} methods.</p>
  *
  * <p> This class enables a good <code>hashCode</code> method to be built for any class. It
  * follows the rules laid out in the book
@@ -112,7 +112,7 @@ import java.lang.reflect.Modifier;
  * @author Gary Gregory
  * @author Pete Gieser
  * @since 1.0
- * @version $Id: HashCodeBuilder.java,v 1.19 2003/08/21 15:52:54 ggregory Exp $
+ * @version $Id: HashCodeBuilder.java,v 1.20 2003/08/23 00:21:49 ggregory Exp $
  */
 public class HashCodeBuilder {
 

src/java/org/apache/commons/lang/builder/ReflectionToStringBuilder.java

@@ -62,7 +62,7 @@ import java.util.Set;
 import org.apache.commons.lang.ClassUtils;
 
 /**
- * <p>Builds <code>toString()</code> values using reflection.</p>
+ * <p>Assists in implementing {@link Object#toString()} methods using reflection.</p>
  *
  * <p>This class uses reflection to determine the fields to append. 
  * Because these fields are usually private, the class 
@@ -100,11 +100,11 @@ import org.apache.commons.lang.ClassUtils;
  * <p>The exact format of the <code>toString</code> is determined by
  * the {@link ToStringStyle} passed into the constructor.</p>
  *
- * @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
+ * @author Gary Gregory
  * @author Stephen Colebourne
  * @author Pete Gieser
  * @since 2.0
- * @version $Id: ReflectionToStringBuilder.java,v 1.9 2003/08/18 02:22:24 bayard Exp $
+ * @version $Id: ReflectionToStringBuilder.java,v 1.10 2003/08/23 00:21:49 ggregory Exp $
  */
 public class ReflectionToStringBuilder extends ToStringBuilder {
 

src/java/org/apache/commons/lang/builder/ToStringBuilder.java

@@ -57,7 +57,7 @@ import org.apache.commons.lang.BooleanUtils;
 import org.apache.commons.lang.ObjectUtils;
 
 /**
- * <p><code>ToString</code> generation routines.</p>
+ * <p>Assists in implementing {@link Object#toString()} methods.</p>
  *
  * <p>This class enables a good and consistent <code>toString()</code> to be built for any
  * class or object. This class aims to simplify the process by:</p>
@@ -125,7 +125,7 @@ import org.apache.commons.lang.ObjectUtils;
  * @author Gary Gregory
  * @author Pete Gieser
  * @since 1.0
- * @version $Id: ToStringBuilder.java,v 1.28 2003/08/21 15:52:54 ggregory Exp $
+ * @version $Id: ToStringBuilder.java,v 1.29 2003/08/23 00:21:49 ggregory Exp $
  */
 public class ToStringBuilder {
 

src/java/org/apache/commons/lang/builder/ToStringStyle.java

@@ -63,9 +63,8 @@ import org.apache.commons.lang.ObjectUtils;
 import org.apache.commons.lang.SystemUtils;
 
 /**
- * <p><code>ToStringStyle</code> works with <code>ToStringBuilder</code>
- * to create a <code>toString</code>. The main public interface is always
- * via <code>ToStringBuilder</code>.</p>
+ * <p>Controls <code>String</code> formatting for {@link ToStringBuilder}.
+ * The main public interface is always via <code>ToStringBuilder</code>.</p>
  *
  * <p>These classes are intended to be used as <code>Singletons</code>.
  * There is no need to instantiate a new style each time. A program
@@ -87,7 +86,7 @@ import org.apache.commons.lang.SystemUtils;
  * @author Gary Gregory
  * @author Pete Gieser
  * @since 1.0
- * @version $Id: ToStringStyle.java,v 1.26 2003/08/22 03:06:36 ggregory Exp $
+ * @version $Id: ToStringStyle.java,v 1.27 2003/08/23 00:21:49 ggregory Exp $
  */
 public abstract class ToStringStyle implements Serializable {