Author: ggregory
Date: Mon Apr 11 18:10:23 2011
New Revision: 1091158
URL: http://svn.apache.org/viewvc?rev=1091158&view=rev
Log:
Javadoc.
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Pair.java
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Pair.java
URL:
http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Pair.java?rev=1091158&r1=1091157&r2=1091158&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Pair.java
(original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/Pair.java
Mon Apr 11 18:10:23 2011
@@ -165,8 +165,16 @@ public abstract class Pair<L, R> impleme
}
/**
- * Returns a String representation in the given format.
- * @param format a {@link Formatter} String.
+ * Returns a String representation in the given format. The format is in
the {@link Formatter} syntax. There are three arguments
+ * available:
+ * <ol>
+ * <li>The simple class name</li>
+ * <li>The left object</li>
+ * <li>The right object</li>
+ * </ol>
+ *
+ * @param format
+ * a {@link Formatter} String.
* @return a string for this object
*/
public String toString(String format) {
