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 e2e25c1035b379436454a11cea651aab02f24271..2b6ad41397b643ce044c4d6a7cafab1c6d18e523 100644 (file)
--- 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()