From 32a94f8e45426f29fcda9c1c48b7e39b6a3dd0de Mon Sep 17 00:00:00 2001 From: Nick Burch Date: Tue, 6 May 2008 15:37:45 +0000 Subject: [PATCH] Improve JavaDocs about iterators and gaps git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@653815 13f79535-47bb-0310-9956-ffa450edef68 --- src/java/org/apache/poi/hssf/usermodel/HSSFRow.java | 6 ++++-- src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java | 1 + 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java b/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java index 0444843d2e..1b83bced9c 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java @@ -479,8 +479,10 @@ public final class HSSFRow implements Comparable { } /** - * @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() { diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java index b56122688e..6d817a1ed9 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java @@ -699,6 +699,7 @@ public final class HSSFSheet { /** * @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() { -- 2.39.5