Add javadoc to CellRange.getReferenceText()

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1647883 13f79535-47bb-0310-9956-ffa450edef68
2014-12-25 08:59:16 +00:00 · 2014-12-25 08:59:16 +00:00 · c7044b77aa
commit c7044b77aa
parent 202aa8177f
1 changed files with 5 additions and 0 deletions
--- 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();

 	/**