Improve Javadoc (I hope!).
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@137284 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/java/org/apache/commons/lang/builder/ToStringBuilder.java b/src/java/org/apache/commons/lang/builder/ToStringBuilder.java
index 9d61d9d..765cada 100644
--- a/src/java/org/apache/commons/lang/builder/ToStringBuilder.java
+++ b/src/java/org/apache/commons/lang/builder/ToStringBuilder.java
@@ -59,16 +59,17 @@
import java.util.Set;
/**
- * <p><code>ToString</code> generation routine.</p>
+ * <p><code>toString()</code> generation routines.</p>
*
- * <p>This class enables a good <code>toString</code> to be built for any
- * class. This class aims to simplify the process by:</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>
* <ul>
* <li>allowing field names
* <li>handling all types consistently
* <li>handling nulls consistently
* <li>outputting arrays and multi-dimensional arrays
* <li>enabling the detail level to be controlled for Objects and Collections
+ * <li>handling class hierarchies
* </ul>
*
* <p>To use this class write code as follows:
@@ -110,13 +111,18 @@
* }
* </pre>
*
+ * <p>You can also use the builder to debug 3rd party objects:</p>
+ * <pre>
+ * System.out.println("An object: " + ToStringBuilder.reflectionToString(anObject));
+ * </pre>
+ *
* <p>The exact format of the <code>toString</code> is determined by
* the {@link ToStringStyle} passed into the constructor.</p>
*
* @author Stephen Colebourne
* @author Gary Gregory
* @since 1.0
- * @version $Id: ToStringBuilder.java,v 1.18 2003/04/08 20:44:10 ggregory Exp $
+ * @version $Id: ToStringBuilder.java,v 1.19 2003/04/08 22:35:40 ggregory Exp $
*/
public class ToStringBuilder {
diff --git a/src/java/org/apache/commons/lang/builder/package.html b/src/java/org/apache/commons/lang/builder/package.html
index 7dca622..c893859 100644
--- a/src/java/org/apache/commons/lang/builder/package.html
+++ b/src/java/org/apache/commons/lang/builder/package.html
@@ -1,6 +1,6 @@
<html>
<body>
-These builders assist with creating good equals(), toString(), hashCode(),
-and compareTo() methods.
+These builders assist with creating good and consistent <code>equals()</code>, <code>toString()</code>,
+<code>hashCode()</code>, and <code>compareTo()</code> methods.
</body>
</html>
diff --git a/src/java/org/apache/commons/lang/package.html b/src/java/org/apache/commons/lang/package.html
index aa32f16..c0fd9a3 100644
--- a/src/java/org/apache/commons/lang/package.html
+++ b/src/java/org/apache/commons/lang/package.html
@@ -1,6 +1,6 @@
<html>
<body>
A collection of highly reusable static utility methods, chiefly concerned
-with adding value to java.lang and other standard core classes.
+with adding value to <code>java.lang</code> and other standard core classes.
</body>
</html>
