You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by fa...@apache.org on 2021/11/20 15:59:37 UTC
svn commit: r1895208 - in /poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/model: Comments.java CommentsTable.java
Author: fanningpj
Date: Sat Nov 20 15:59:37 2021
New Revision: 1895208
URL: http://svn.apache.org/viewvc?rev=1895208&view=rev
Log:
javadoc
Modified:
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java
Modified: poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java
URL: http://svn.apache.org/viewvc/poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java?rev=1895208&r1=1895207&r2=1895208&view=diff
==============================================================================
--- poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java (original)
+++ poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java Sat Nov 20 15:59:37 2021
@@ -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<CellAddress> 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
*/
Modified: poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java
URL: http://svn.apache.org/viewvc/poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java?rev=1895208&r1=1895207&r2=1895208&view=diff
==============================================================================
--- poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java (original)
+++ poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java Sat Nov 20 15:59:37 2021
@@ -101,7 +101,8 @@ public class CommentsTable extends POIXM
}
/**
- * @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 POIXM
*
* @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 POIXM
/**
* 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
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org