From 8b85912bed56ba737547bfcbbdc74c66f2ff94d2 Mon Sep 17 00:00:00 2001
From: Yegor Kozlov
Date: Mon, 6 Jun 2011 08:45:06 +0000
Subject: [PATCH] cleaned javadocs warnings
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1132549 13f79535-47bb-0310-9956-ffa450edef68
---
src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java | 1 -
.../org/apache/poi/poifs/filesystem/DirectoryNode.java | 2 +-
.../org/apache/poi/poifs/property/PropertyTableBase.java | 4 ++--
src/java/org/apache/poi/ss/formula/functions/Irr.java | 8 +++++---
.../java/org/apache/poi/openxml4j/opc/OPCPackage.java | 3 ---
.../java/org/apache/poi/xwpf/usermodel/XWPFDocument.java | 2 +-
.../org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java | 2 +-
.../java/org/apache/poi/xwpf/usermodel/XWPFNumbering.java | 2 +-
.../java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java | 2 --
.../java/org/apache/poi/xwpf/usermodel/XWPFSettings.java | 1 -
src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java | 1 -
src/scratchpad/src/org/apache/poi/hwpf/HWPFDocument.java | 2 +-
.../src/org/apache/poi/hwpf/HWPFDocumentCore.java | 2 +-
13 files changed, 13 insertions(+), 19 deletions(-)
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
index b7101940cf..a0007fcee7 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
@@ -266,7 +266,6 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss
* low level models. If you're reading in a workbook...start here.
*
* @param directory the POI filesystem directory to process from
- * @param fs the POI filesystem that contains the Workbook stream.
* @param preserveNodes whether to preseve other nodes, such as
* macros. This takes more memory, so only say yes if you
* need to. If set, will store all of the POIFSFileSystem
diff --git a/src/java/org/apache/poi/poifs/filesystem/DirectoryNode.java b/src/java/org/apache/poi/poifs/filesystem/DirectoryNode.java
index d5c75ea17c..d6f86d5ef4 100644
--- a/src/java/org/apache/poi/poifs/filesystem/DirectoryNode.java
+++ b/src/java/org/apache/poi/poifs/filesystem/DirectoryNode.java
@@ -180,7 +180,7 @@ public class DirectoryNode
/**
* open a document in the directory's entry's list of entries
*
- * @param documentEntry the document to be opened
+ * @param document the document to be opened
*
* @return a newly opened DocumentInputStream or NDocumentInputStream
*
diff --git a/src/java/org/apache/poi/poifs/property/PropertyTableBase.java b/src/java/org/apache/poi/poifs/property/PropertyTableBase.java
index a3520815e3..b3690c5c24 100644
--- a/src/java/org/apache/poi/poifs/property/PropertyTableBase.java
+++ b/src/java/org/apache/poi/poifs/property/PropertyTableBase.java
@@ -48,8 +48,8 @@ public abstract class PropertyTableBase implements BATManaged {
* to extract the property table from it). Populates the
* properties thoroughly
*
- * @param startBlock the first block of the property table
- * @param blockList the list of blocks
+ * @param header_block the first block to read from
+ * @param properties the list to populate
*
* @exception IOException if anything goes wrong (which should be
* a result of the input being NFG)
diff --git a/src/java/org/apache/poi/ss/formula/functions/Irr.java b/src/java/org/apache/poi/ss/formula/functions/Irr.java
index 27f7232eb2..a2faf181ca 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Irr.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Irr.java
@@ -75,7 +75,7 @@ public final class Irr implements Function {
*
*
* The implementation is inspired by the NewtonSolver from the Apache Commons-Math library,
- * @see {http://commons.apache.org/}
+ * @see http://commons.apache.org
*
*
* @param values the income values.
@@ -83,8 +83,10 @@ public final class Irr implements Function {
* @return the irr value. The method returns Double.NaN
* if the maximum iteration count is exceeded
*
- * @see {http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution}
- * @see {http://en.wikipedia.org/wiki/Newton%27s_method}
+ * @see
+ * http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution
+ * @see
+ * http://en.wikipedia.org/wiki/Newton%27s_method
*/
public static double irr(double[] values, double guess) {
int maxIterationCount = 20;
diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
index a9b08eec3a..6ec685cb4e 100644
--- a/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
+++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
@@ -556,9 +556,6 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
return retArr;
}
- /**
- * @return
- */
public List getPartsByName(final Pattern namePattern) {
if (namePattern == null) {
throw new IllegalArgumentException("name pattern must not be null");
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
index 517c72358e..c21822d587 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
@@ -495,7 +495,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
- * add a new paragraph at position of the cursor. The cursor must be on the
+ * Add a new paragraph at position of the cursor. The cursor must be on the
* {@link TokenType#START} tag of an subelement of the documents body. When
* this method is done, the cursor passed as parameter points to the
* {@link TokenType#END} of the newly inserted paragraph.
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java
index 482994b128..59b667f3bb 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java
@@ -226,7 +226,7 @@ public abstract class XWPFHeaderFooter extends POIXMLDocumentPart implements IBo
/**
* Adds a picture to the document.
*
- * @param is The stream to read image from
+ * @param pictureData The picture data
* @param format The format of the picture.
*
* @return the index to this picture (0 based), the added picture can be obtained from {@link #getAllPictures()} .
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFNumbering.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFNumbering.java
index 861b07409b..2b4ca7049a 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFNumbering.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFNumbering.java
@@ -166,7 +166,7 @@ public class XWPFNumbering extends POIXMLDocumentPart {
/**
* Add a new num with an abstractNumID and a numID
- * @param abstractNumId
+ * @param abstractNumID
* @param numID
*/
public void addNum(BigInteger abstractNumID, BigInteger numID){
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java
index 8c5582bc82..5190f22840 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java
@@ -1270,7 +1270,6 @@ public class XWPFParagraph implements IBodyElement {
* adds a new Run to the Paragraph
*
* @param r
- * @return
*/
public void addRun(XWPFRun r) {
if (!runs.contains(r)) {
@@ -1282,7 +1281,6 @@ public class XWPFParagraph implements IBodyElement {
* return the XWPFRun-Element which owns the CTR run-Element
*
* @param r
- * @return
*/
public XWPFRun getRun(CTR r) {
for (int i = 0; i < getRuns().size(); i++) {
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java
index 18d787504a..84b9fdf66c 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java
@@ -87,7 +87,6 @@ public class XWPFSettings extends POIXMLDocumentPart {
*
* <w:zoom w:percent="50" />
*
- * @return percentage as an integer of zoom level
*/
public void setZoomPercent(long zoomPercent) {
if (! ctSettings.isSetZoom()) {
diff --git a/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java b/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java
index 4d00e79e41..91c4c7479c 100644
--- a/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java
+++ b/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java
@@ -118,7 +118,6 @@ public class MAPIMessage extends POIDocument {
* Constructor for reading MSG Files from a certain
* point within a POIFS filesystem
* @param poifsDir
- * @param fs
* @throws IOException
*/
public MAPIMessage(DirectoryNode poifsDir) throws IOException {
diff --git a/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocument.java b/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocument.java
index 98fbfbe96d..c5c4d82aa8 100644
--- a/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocument.java
+++ b/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocument.java
@@ -152,7 +152,7 @@ public final class HWPFDocument extends HWPFDocumentCore
* in a POIFSFileSystem, probably not the default.
* Used typically to open embeded documents.
*
- * @param pfilesystem The POIFSFileSystem that contains the Word document.
+ * @param directory The DirectoryNode that contains the Word document.
* @throws IOException If there is an unexpected IOException from the passed
* in POIFSFileSystem.
*/
diff --git a/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocumentCore.java b/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocumentCore.java
index 75eb565f3a..e37aee1f29 100644
--- a/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocumentCore.java
+++ b/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocumentCore.java
@@ -126,7 +126,7 @@ public abstract class HWPFDocumentCore extends POIDocument
* in a POIFSFileSystem, probably not the default.
* Used typically to open embeded documents.
*
- * @param pfilesystem The POIFSFileSystem that contains the Word document.
+ * @param directory The DirectoryNode that contains the Word document.
* @throws IOException If there is an unexpected IOException from the passed
* in POIFSFileSystem.
*/
--
2.39.5