aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJaven O'Neal <onealj@apache.org>2016-10-07 12:39:15 +0000
committerJaven O'Neal <onealj@apache.org>2016-10-07 12:39:15 +0000
commit21627eb1ab5ab8bf3eec9113a19739a9fc0241a8 (patch)
treebe474c6f7f48b94e10300e4ece1ecea84af3d09a
parentc5dbecedab984c4110dfd75b474c511cedd32a8d (diff)
downloadpoi-21627eb1ab5ab8bf3eec9113a19739a9fc0241a8.tar.gz
poi-21627eb1ab5ab8bf3eec9113a19739a9fc0241a8.zip
bug 60216: javadocx fix for Comment#isVisible and Comment#setVisible; patch from Daniel Kueppers
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1763757 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r--src/java/org/apache/poi/hssf/usermodel/HSSFComment.java4
-rw-r--r--src/java/org/apache/poi/ss/usermodel/Comment.java4
-rw-r--r--src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFComment.java8
3 files changed, 10 insertions, 6 deletions
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFComment.java b/src/java/org/apache/poi/hssf/usermodel/HSSFComment.java
index 0013bd12e1..593f362c4a 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFComment.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFComment.java
@@ -143,7 +143,7 @@ public class HSSFComment extends HSSFTextbox implements Comment {
}
/**
- * Returns whether this comment is visible.
+ * Sets whether this comment is visible.
*
* @param visible <code>true</code> if the comment is visible, <code>false</code> otherwise
*/
@@ -154,7 +154,7 @@ public class HSSFComment extends HSSFTextbox implements Comment {
}
/**
- * Sets whether this comment is visible.
+ * Returns whether this comment is visible.
*
* @return <code>true</code> if the comment is visible, <code>false</code> otherwise
*/
diff --git a/src/java/org/apache/poi/ss/usermodel/Comment.java b/src/java/org/apache/poi/ss/usermodel/Comment.java
index 311b39f6c1..c39040cfe3 100644
--- a/src/java/org/apache/poi/ss/usermodel/Comment.java
+++ b/src/java/org/apache/poi/ss/usermodel/Comment.java
@@ -22,14 +22,14 @@ import org.apache.poi.ss.util.CellAddress;
public interface Comment {
/**
- * Returns whether this comment is visible.
+ * Sets whether this comment is visible.
*
* @param visible <code>true</code> if the comment is visible, <code>false</code> otherwise
*/
void setVisible(boolean visible);
/**
- * Sets whether this comment is visible.
+ * Returns whether this comment is visible.
*
* @return <code>true</code> if the comment is visible, <code>false</code> otherwise
*/
diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFComment.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFComment.java
index 7140e5b902..6e69fa91ec 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFComment.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFComment.java
@@ -102,7 +102,9 @@ public class XSSFComment implements Comment {
}
/**
- * @return whether the comment is visible
+ * Returns whether this comment is visible.
+ *
+ * @return <code>true</code> if the comment is visible, <code>false</code> otherwise
*/
@Override
public boolean isVisible() {
@@ -115,7 +117,9 @@ public class XSSFComment implements Comment {
}
/**
- * @param visible whether the comment is visible
+ * Sets whether this comment is visible.
+ *
+ * @param visible <code>true</code> if the comment is visible, <code>false</code> otherwise
*/
@Override
public void setVisible(boolean visible) {