From: Dominik Stadler <centic@apache.org>
Date: Thu, 25 Dec 2014 08:59:16 +0000 (+0000)
Subject: Add javadoc to CellRange.getReferenceText()
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=c7044b77aad61840329c8c61a8734151fe885d60;p=poi.git

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 9bdd4baab9..9c25f870c1 100644
--- 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();
 
 	/**