From 6a1dc2997c42475289022fa61e0f4bb7601a6483 Mon Sep 17 00:00:00 2001 From: "Gary D. Gregory" Date: Tue, 8 Apr 2003 22:36:04 +0000 Subject: [PATCH] Improve Javadoc (I hope!). git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@137284 13f79535-47bb-0310-9956-ffa450edef68 --- .../commons/lang/builder/ToStringBuilder.java | 14 ++++++++++---- .../org/apache/commons/lang/builder/package.html | 4 ++-- src/java/org/apache/commons/lang/package.html | 2 +- 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/src/java/org/apache/commons/lang/builder/ToStringBuilder.java b/src/java/org/apache/commons/lang/builder/ToStringBuilder.java index 9d61d9daa..765cadac3 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.HashSet; import java.util.Set; /** - *

ToString generation routine.

+ *

toString() generation routines.

* - *

This class enables a good toString to be built for any - * class. This class aims to simplify the process by:

+ *

This class enables a good and consistent toString() to be built for any + * class or object. This class aims to simplify the process by:

* * *

To use this class write code as follows: @@ -110,13 +111,18 @@ import java.util.Set; * } * * + *

You can also use the builder to debug 3rd party objects:

+ * 
+ * System.out.println("An object: " + ToStringBuilder.reflectionToString(anObject));
+ *
+ * *

The exact format of the toString is determined by * the {@link ToStringStyle} passed into the constructor.

* * @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 7dca622a8..c893859a8 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 @@ -These builders assist with creating good equals(), toString(), hashCode(), -and compareTo() methods. +These builders assist with creating good and consistent equals(), toString(), +hashCode(), and compareTo() methods. diff --git a/src/java/org/apache/commons/lang/package.html b/src/java/org/apache/commons/lang/package.html index aa32f160c..c0fd9a31a 100644 --- a/src/java/org/apache/commons/lang/package.html +++ b/src/java/org/apache/commons/lang/package.html @@ -1,6 +1,6 @@ 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 java.lang and other standard core classes.