From: Nick Burch <nick@apache.org>
Date: Wed, 26 Jun 2013 00:56:28 +0000 (+0000)
Subject: Fix JavaDoc warnings
X-Git-Tag: REL_3_10_BETA2~65
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=3fa0d1813251bb51f154c37a3061d9bcd1a66563;p=poi.git

Fix JavaDoc warnings

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1496701 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/src/java/org/apache/poi/POIDocument.java b/src/java/org/apache/poi/POIDocument.java
index 5b1c2da9b5..a1a8fe1c80 100644
--- a/src/java/org/apache/poi/POIDocument.java
+++ b/src/java/org/apache/poi/POIDocument.java
@@ -236,7 +236,7 @@ public abstract class POIDocument {
      * @param source is the source POIFS to copy from
      * @param target is the target POIFS to copy to
      * @param excepts is a list of Strings specifying what nodes NOT to copy
-     * @deprecated Use {@link EntryUtils#copyNodes(DirectoryEntry, DirectoryEntry, List<String>)} instead
+     * @deprecated Use {@link EntryUtils#copyNodes(DirectoryEntry, DirectoryEntry, List)} instead
      */
     @Deprecated
     protected void copyNodes( POIFSFileSystem source, POIFSFileSystem target,
@@ -249,7 +249,7 @@ public abstract class POIDocument {
     * @param sourceRoot is the source POIFS to copy from
     * @param targetRoot is the target POIFS to copy to
     * @param excepts is a list of Strings specifying what nodes NOT to copy
-    * @deprecated Use {@link EntryUtils#copyNodes(DirectoryEntry, DirectoryEntry, List<String>)} instead
+    * @deprecated Use {@link EntryUtils#copyNodes(DirectoryEntry, DirectoryEntry, List)} instead
     */
     @Deprecated
     protected void copyNodes( DirectoryNode sourceRoot,
diff --git a/src/ooxml/java/org/apache/poi/xssf/model/CommentsTable.java b/src/ooxml/java/org/apache/poi/xssf/model/CommentsTable.java
index 6a038d65ac..f3799ab24e 100644
--- a/src/ooxml/java/org/apache/poi/xssf/model/CommentsTable.java
+++ b/src/ooxml/java/org/apache/poi/xssf/model/CommentsTable.java
@@ -128,9 +128,8 @@ public class CommentsTable extends POIXMLDocumentPart {
 
     /**
      * This method is deprecated and should not be used any more as
-     * it overwrites the comment in Cell A1.
-     *
-     * @return
+     * it silently overwrites the comment in Cell A1 if present
+     * @deprecated Use {@link #newComment(String)} instead to explicitly set the cell reference to create for
      */
     @Deprecated
     public CTComment newComment() {