Author: yegor
Date: Mon Jun 6 08:45:06 2011
New Revision: 1132549
URL: http://svn.apache.org/viewvc?rev=1132549&view=rev
Log:
cleaned javadocs warnings
Modified:
poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
poi/trunk/src/java/org/apache/poi/poifs/filesystem/DirectoryNode.java
poi/trunk/src/java/org/apache/poi/poifs/property/PropertyTableBase.java
poi/trunk/src/java/org/apache/poi/ss/formula/functions/Irr.java
poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java
poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFNumbering.java
poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java
poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java
poi/trunk/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java
poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocument.java
poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocumentCore.java
Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java?rev=1132549&r1=1132548&r2=1132549&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java Mon Jun 6 08:45:06
2011
@@ -266,7 +266,6 @@ public final class HSSFWorkbook extends
* 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
Modified: poi/trunk/src/java/org/apache/poi/poifs/filesystem/DirectoryNode.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/poifs/filesystem/DirectoryNode.java?rev=1132549&r1=1132548&r2=1132549&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/poifs/filesystem/DirectoryNode.java (original)
+++ poi/trunk/src/java/org/apache/poi/poifs/filesystem/DirectoryNode.java Mon Jun 6 08:45:06
2011
@@ -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
*
Modified: poi/trunk/src/java/org/apache/poi/poifs/property/PropertyTableBase.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/poifs/property/PropertyTableBase.java?rev=1132549&r1=1132548&r2=1132549&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/poifs/property/PropertyTableBase.java (original)
+++ poi/trunk/src/java/org/apache/poi/poifs/property/PropertyTableBase.java Mon Jun 6 08:45:06
2011
@@ -48,8 +48,8 @@ public abstract class PropertyTableBase
* 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)
Modified: poi/trunk/src/java/org/apache/poi/ss/formula/functions/Irr.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/functions/Irr.java?rev=1132549&r1=1132548&r2=1132549&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/formula/functions/Irr.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/formula/functions/Irr.java Mon Jun 6 08:45:06 2011
@@ -75,7 +75,7 @@ public final class Irr implements Functi
* </p>
* <p>
* The implementation is inspired by the NewtonSolver from the Apache Commons-Math
library,
- * @see {http://commons.apache.org/}
+ * @see <a href="http://commons.apache.org">http://commons.apache.org</a>
* </p>
*
* @param values the income values.
@@ -83,8 +83,10 @@ public final class Irr implements Functi
* @return the irr value. The method returns <code>Double.NaN</code>
* 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 <a href="http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution">
+ * http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution</a>
+ * @see <a href="http://en.wikipedia.org/wiki/Newton%27s_method">
+ * http://en.wikipedia.org/wiki/Newton%27s_method</a>
*/
public static double irr(double[] values, double guess) {
int maxIterationCount = 20;
Modified: poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java?rev=1132549&r1=1132548&r2=1132549&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java Mon Jun 6 08:45:06
2011
@@ -556,9 +556,6 @@ public abstract class OPCPackage impleme
return retArr;
}
- /**
- * @return
- */
public List<PackagePart> getPartsByName(final Pattern namePattern) {
if (namePattern == null) {
throw new IllegalArgumentException("name pattern must not be null");
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java?rev=1132549&r1=1132548&r2=1132549&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java Mon Jun 6 08:45:06
2011
@@ -495,7 +495,7 @@ public class XWPFDocument extends POIXML
}
/**
- * 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.
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java?rev=1132549&r1=1132548&r2=1132549&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFHeaderFooter.java Mon Jun
6 08:45:06 2011
@@ -226,7 +226,7 @@ public abstract class XWPFHeaderFooter e
/**
* 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()} .
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFNumbering.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFNumbering.java?rev=1132549&r1=1132548&r2=1132549&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFNumbering.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFNumbering.java Mon Jun 6 08:45:06
2011
@@ -166,7 +166,7 @@ public class XWPFNumbering extends POIXM
/**
* Add a new num with an abstractNumID and a numID
- * @param abstractNumId
+ * @param abstractNumID
* @param numID
*/
public void addNum(BigInteger abstractNumID, BigInteger numID){
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java?rev=1132549&r1=1132548&r2=1132549&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java Mon Jun 6 08:45:06
2011
@@ -1270,7 +1270,6 @@ public class XWPFParagraph implements IB
* 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 IB
* 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++) {
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java?rev=1132549&r1=1132548&r2=1132549&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java Mon Jun 6 08:45:06
2011
@@ -87,7 +87,6 @@ public class XWPFSettings extends POIXML
* <pre>
* <w:zoom w:percent="50" />
* <pre>
- * @return percentage as an integer of zoom level
*/
public void setZoomPercent(long zoomPercent) {
if (! ctSettings.isSetZoom()) {
Modified: poi/trunk/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java?rev=1132549&r1=1132548&r2=1132549&view=diff
==============================================================================
--- poi/trunk/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java (original)
+++ poi/trunk/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java Mon Jun 6 08:45:06
2011
@@ -118,7 +118,6 @@ public class MAPIMessage extends POIDocu
* 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 {
Modified: poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocument.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocument.java?rev=1132549&r1=1132548&r2=1132549&view=diff
==============================================================================
--- poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocument.java (original)
+++ poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocument.java Mon Jun 6 08:45:06
2011
@@ -152,7 +152,7 @@ public final class HWPFDocument extends
* 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.
*/
Modified: poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocumentCore.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocumentCore.java?rev=1132549&r1=1132548&r2=1132549&view=diff
==============================================================================
--- poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocumentCore.java (original)
+++ poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/HWPFDocumentCore.java Mon Jun 6 08:45:06
2011
@@ -126,7 +126,7 @@ public abstract class HWPFDocumentCore e
* 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.
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org
|