From: Nick Burch <nick@apache.org>
Date: Thu, 10 Jul 2008 22:39:53 +0000 (+0000)
Subject: Improve javadocs relating to getLastRowNumber
X-Git-Tag: REL_3_2_FINAL~249
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=a817230732d857295ab7a1067aa8857af9e3502a;p=poi.git

Improve javadocs relating to getLastRowNumber

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

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
index e2e25c1035..2b6ad41397 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
@@ -347,18 +347,25 @@ public final class HSSFSheet {
     }
 
     /**
-     * gets the first row on the sheet
-     * @return the number of the first logical row on the sheet
+     * Gets the first row on the sheet
+     * @return the number of the first logical row on the sheet, zero based
      */
-
     public int getFirstRowNum()
     {
         return firstrow;
     }
 
     /**
-     * gets the last row on the sheet
-     * @return last row contained n this sheet.
+     * Gets the number last row on the sheet.
+     * Owing to idiosyncrasies in the excel file
+     *  format, if the result of calling this method
+     *  is zero, you can't tell if that means there 
+     *  are zero rows on the sheet, or one at
+     *  position zero. For that case, additionally
+     *  call {@link #getPhysicalNumberOfRows()} to
+     *  tell if there is a row at position zero
+     *  or not. 
+     * @return the number of the last row contained in this sheet, zero based.
      */
 
     public int getLastRowNum()