From dbcaeecb4fac72b3b31a4551628c7f038ee352cc Mon Sep 17 00:00:00 2001
From: Stephen Colebourne <scolebourne@apache.org>
Date: Tue, 12 Apr 2011 14:13:25 +0000
Subject: [PATCH] Javadoc

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@1091420 13f79535-47bb-0310-9956-ffa450edef68
---
 .../java/org/apache/commons/lang3/Pair.java    | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

diff --git a/src/main/java/org/apache/commons/lang3/Pair.java b/src/main/java/org/apache/commons/lang3/Pair.java
index 5747e356a..ce005de42 100644
--- a/src/main/java/org/apache/commons/lang3/Pair.java
+++ b/src/main/java/org/apache/commons/lang3/Pair.java
@@ -43,7 +43,9 @@ public abstract class Pair<L, R> implements Map.Entry<L, R>, Comparable<Pair<L,
 
     /** Serialization version */
     private static final long serialVersionUID = 4954918890077093841L;
-
+    /**
+     * The default format for the toString method.
+     */
     private static final String DEFAULT_FORMAT_STRING = "(%2$s,%3$s)";
 
     /**
@@ -153,7 +155,7 @@ public int hashCode() {
     /**
      * <p>Returns a String representation of the Pair in the form: (L,R).</p>
      * 
-     * @return a string for this object
+     * @return a string describing this object, not null
      */
     @Override
     public String toString() {
@@ -161,19 +163,21 @@ public String toString() {
     }
 
     /**
-     * Returns a String representation in the given format. The format is in the {@link Formatter} syntax. There are three arguments
-     * available:
+     * <p>Returns a String representation in the given format.</p>
+     * 
+     * <p>The format specified uses the syntax from {@link Formatter}.
+     * There are three arguments available:</p>
      * <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
+     * @param format  the format suitable for use with {@code Formatter}, not null
+     * @return a string describing for this object, not null
      */
     public String toString(String format) {
         return String.format(format, getClass().getSimpleName(), getLeft(), getRight());
     }
+
 }