Add javadoc to CellRange.getReferenceText()

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1647883 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/java/org/apache/poi/ss/usermodel/CellRange.java b/src/java/org/apache/poi/ss/usermodel/CellRange.java
index 9bdd4baab96c5fbe16a3ca35f9d02474c583c79d..9c25f870c1c36807193ec119a887d558081add9e 100644 (file)
--- a/src/java/org/apache/poi/ss/usermodel/CellRange.java
+++ b/src/java/org/apache/poi/ss/usermodel/CellRange.java
@@ -34,6 +34,11 @@ public interface CellRange<C extends Cell> extends Iterable<C> {
         * @return <tt>height * width </tt>
         */
        int size();
+
+    /**
+     * @return the text format of this range.  Single cell ranges are formatted
+     *         like single cell references (e.g. 'A1' instead of 'A1:A1').
+     */
        String getReferenceText();
 
        /**