svn commit: r653815 - in /poi/trunk/src/java/org/apache/poi/hssf/usermodel: HSSFRow.java HSSFSheet.java

[ni...@apache.org]

Author: nick
Date: Tue May  6 08:37:45 2008
New Revision: 653815

URL: http://svn.apache.org/viewvc?rev=653815&view=rev
Log:
Improve JavaDocs about iterators and gaps

Modified:
    poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java
    poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java

Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java?rev=653815&r1=653814&r2=653815&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java Tue May  6 08:37:45 2008
@@ -479,8 +479,10 @@
     }
 
     /**
-     * @return cell iterator of the physically defined cells.  Note element 4 may
-     * actually be row cell depending on how many are defined!
+     * @return cell iterator of the physically defined cells. 
+     * Note that the 4th element might well not be cell 4, as the iterator
+     *  will not return un-defined (null) cells.
+     * Call getCellNum() on the returned cells to know which cell they are.
      */
     public Iterator cellIterator()
     {

Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java?rev=653815&r1=653814&r2=653815&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java Tue May  6 08:37:45 2008
@@ -699,6 +699,7 @@
     /**
      * @return an iterator of the PHYSICAL rows.  Meaning the 3rd element may not
      * be the third row if say for instance the second row is undefined.
+     * Call getRowNum() on each row if you care which one it is.
      */
     public Iterator rowIterator()
     {



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org