diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java index 96f867a9ec..fe4a3ec8b3 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java @@ -43,15 +43,18 @@ public interface Comments { * * @param cellAddress the address of the cell to find a comment * @return cell comment if one exists, otherwise returns null + * @see #findCellComment(Sheet, CellAddress) */ XSSFComment findCellComment(CellAddress cellAddress); /** * Finds the cell comment at cellAddress, if one exists * - * @param sheet the sheet that has the comment + * @param sheet the sheet to check for comments (used to find drawing/shape data for comments) - set to null + * if you don't need the drawing/shape data * @param cellAddress the address of the cell to find a comment * @return cell comment if one exists, otherwise returns null + * @see #findCellComment(CellAddress) * @since POI 5.2.0 */ public XSSFComment findCellComment(Sheet sheet, CellAddress cellAddress); @@ -72,7 +75,8 @@ public interface Comments { Iterator getCellAddresses(); /** - * @param sheet the sheet to check for comments + * @param sheet the sheet to check for comments (used to find drawing/shape data for comments) - set to null + * if you don't need the drawing/shape data * @return iterator of comments * @since POI 5.2.0 */ diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java index f405eba754..d9fbde7936 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java @@ -101,7 +101,8 @@ public class CommentsTable extends POIXMLDocumentPart implements Comments { } /** - * @param sheet the sheet to check for comments + * @param sheet the sheet to check for comments (used to find drawing/shape data for comments) - set to null + * if you don't need the drawing/shape data * @return iterator of comments * @since POI 5.2.0 */ @@ -206,6 +207,7 @@ public class CommentsTable extends POIXMLDocumentPart implements Comments { * * @param cellAddress the address of the cell to find a comment * @return cell comment if one exists, otherwise returns null + * @see #findCellComment(Sheet, CellAddress) */ @Override public XSSFComment findCellComment(CellAddress cellAddress) { @@ -216,9 +218,11 @@ public class CommentsTable extends POIXMLDocumentPart implements Comments { /** * Finds the cell comment at cellAddress, if one exists * - * @param sheet the sheet that has the comment + * @param sheet the sheet to check for comments (used to find drawing/shape data for comments) - set to null + * if you don't need the drawing/shape data * @param cellAddress the address of the cell to find a comment * @return cell comment if one exists, otherwise returns null + * @see #findCellComment(CellAddress) * @since POI 5.2.0 */ @Override