javadoc house-keeping

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

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFPatriarch.java b/src/java/org/apache/poi/hssf/usermodel/HSSFPatriarch.java
index 46395b51c8d09effb73fd84e1d4756ad527f5891..7745801fd2362ff5db15830a5e44d6a56499a203 100644 (file)
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFPatriarch.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFPatriarch.java
@@ -45,6 +45,7 @@ import org.apache.poi.hssf.record.ObjRecord;
 import org.apache.poi.hssf.util.CellReference;
 import org.apache.poi.poifs.filesystem.DirectoryEntry;
 import org.apache.poi.poifs.filesystem.DirectoryNode;
+import org.apache.poi.poifs.filesystem.POIFSFileSystem;
 import org.apache.poi.ss.usermodel.Chart;
 import org.apache.poi.ss.usermodel.ClientAnchor;
 import org.apache.poi.ss.usermodel.Drawing;
@@ -218,7 +219,7 @@ public final class HSSFPatriarch implements HSSFShapeContainer, Drawing {
      * 
      * @param anchor       the client anchor describes how this picture is
      *                     attached to the sheet.
-     * @param storageId    the storageId returned by {@link HSSFWorkbook.addOlePackage}
+     * @param storageId    the storageId returned by {@link HSSFWorkbook#addOlePackage(POIFSFileSystem,String,String,String)}
      * @param pictureIndex the index of the picture (used as preview image) in the
      *                     workbook collection of pictures.
      *

diff --git a/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java b/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java
index 42ca4341980a8544dea3f11c6a1b5eecc364861e..7286823a1b65a2b56c24259a6f909f12156df452 100644 (file)
--- a/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java
+++ b/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java
@@ -65,13 +65,13 @@ public class CryptoFunctions {
      * monotonically on each iteration until PasswordKey.spinCount iterations have been performed.\r
      * The value of iterator on the last iteration MUST be one less than PasswordKey.spinCount.\r
      * \r
-     * For POI, H_final will be calculated by {@link generateKey()}\r
+     * For POI, H_final will be calculated by {@link #generateKey(byte[],HashAlgorithm,byte[],int)}\r
      *\r
      * @param password\r
      * @param hashAlgorithm\r
      * @param salt\r
      * @param spinCount\r
-     * @return\r
+     * @return the hashed password\r
      */\r
     public static byte[] hashPassword(String password, HashAlgorithm hashAlgorithm, byte salt[], int spinCount) {\r
         // If no password was given, use the default\r
@@ -146,7 +146,7 @@ public class CryptoFunctions {
      * @param hashAlgorithm\r
      * @param blockKey\r
      * @param keySize\r
-     * @return\r
+     * @return intermediate key\r
      */\r
     public static byte[] generateKey(byte[] passwordHash, HashAlgorithm hashAlgorithm, byte[] blockKey, int keySize) {\r
         MessageDigest hashAlgo = getMessageDigest(hashAlgorithm);\r
@@ -166,7 +166,7 @@ public class CryptoFunctions {
      * @param chain\r
      * @param vec\r
      * @param cipherMode Cipher.DECRYPT_MODE or Cipher.ENCRYPT_MODE\r
-     * @return\r
+     * @return the requested cipher\r
      * @throws GeneralSecurityException\r
      */\r
     public static Cipher getCipher(SecretKey key, CipherAlgorithm cipherAlgorithm, ChainingMode chain, byte[] vec, int cipherMode, String padding) {\r

diff --git a/src/java/org/apache/poi/poifs/property/NPropertyTable.java b/src/java/org/apache/poi/poifs/property/NPropertyTable.java
index 4f3a1968e62a23070495d267dc9db13c48757c34..aed08a521b6a304fb27afe24434faa241ce817fc 100644 (file)
--- a/src/java/org/apache/poi/poifs/property/NPropertyTable.java
+++ b/src/java/org/apache/poi/poifs/property/NPropertyTable.java
@@ -77,7 +77,6 @@ public final class NPropertyTable extends PropertyTableBase {
      * Builds
      * @param startAt
      * @param filesystem
-     * @return
      * @throws IOException
      */
     private static List<Property> buildProperties(final Iterator<ByteBuffer> dataSource,

diff --git a/src/java/org/apache/poi/ss/formula/functions/Complex.java b/src/java/org/apache/poi/ss/formula/functions/Complex.java
index 7f205f3ffe623c639cacc16d3db27624049bbc15..1e0bd5bfdcde22f337edb1cc7a4ac89aa5104bbd 100644 (file)
--- a/src/java/org/apache/poi/ss/formula/functions/Complex.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Complex.java
@@ -18,7 +18,11 @@
 package org.apache.poi.ss.formula.functions;\r
 \r
 import org.apache.poi.ss.formula.OperationEvaluationContext;\r
-import org.apache.poi.ss.formula.eval.*;\r
+import org.apache.poi.ss.formula.eval.ErrorEval;\r
+import org.apache.poi.ss.formula.eval.EvaluationException;\r
+import org.apache.poi.ss.formula.eval.OperandResolver;\r
+import org.apache.poi.ss.formula.eval.StringEval;\r
+import org.apache.poi.ss.formula.eval.ValueEval;\r
 \r
 /**\r
  * Implementation for Excel COMPLEX () function.<p/>\r
@@ -126,10 +130,6 @@ public class Complex extends Var2or3ArgFunction implements FreeRefFunction {
         return new StringEval(strb.toString());\r
     }\r
 \r
-    /**\r
-     * @param number\r
-     * @return\r
-     */\r
     private boolean isDoubleAnInt(double number) {\r
         return (number == Math.floor(number)) && !Double.isInfinite(number);\r
     }\r

diff --git a/src/java/org/apache/poi/ss/formula/functions/Mirr.java b/src/java/org/apache/poi/ss/formula/functions/Mirr.java
index e98433976af398810d46c1c8344bece04f2edb8b..934f508811a9e7731dfd6ca45388a79fd474dc12 100644 (file)
--- a/src/java/org/apache/poi/ss/formula/functions/Mirr.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Mirr.java
@@ -41,7 +41,7 @@ import org.apache.poi.ss.formula.eval.EvaluationException;
  *\r
  * @see <a href="http://en.wikipedia.org/wiki/MIRR">Wikipedia on MIRR</a>\r
  * @see <a href="http://office.microsoft.com/en-001/excel-help/mirr-HP005209180.aspx">Excel MIRR</a>\r
- * @see {@link Irr}\r
+ * @see Irr\r
  */\r
 public class Mirr extends MultiOperandNumericFunction {\r
 \r

diff --git a/src/java/org/apache/poi/ss/formula/functions/Roman.java b/src/java/org/apache/poi/ss/formula/functions/Roman.java
index d1abd9acc4212ed5f4a6cfa6252e88eb62295c6c..45b400e2f7b82cc157780fee98a84c46993a48dc 100644 (file)
--- a/src/java/org/apache/poi/ss/formula/functions/Roman.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Roman.java
@@ -17,7 +17,11 @@
 \r
 package org.apache.poi.ss.formula.functions;\r
 \r
-import org.apache.poi.ss.formula.eval.*;\r
+import org.apache.poi.ss.formula.eval.ErrorEval;\r
+import org.apache.poi.ss.formula.eval.EvaluationException;\r
+import org.apache.poi.ss.formula.eval.OperandResolver;\r
+import org.apache.poi.ss.formula.eval.StringEval;\r
+import org.apache.poi.ss.formula.eval.ValueEval;\r
 \r
 /**\r
  * Implementation for Excel WeekNum() function.<p/>\r
@@ -87,7 +91,6 @@ public class Roman extends Fixed2ArgFunction {
      * Classic conversion.\r
      *\r
      * @param number\r
-     * @return\r
      */\r
     private String integerToRoman(int number) {\r
         StringBuilder result = new StringBuilder();\r
@@ -105,7 +108,6 @@ public class Roman extends Fixed2ArgFunction {
      *\r
      * @param result\r
      * @param form\r
-     * @return\r
      */\r
     public String makeConcise(String result, int form) {\r
         if (form > 0) {\r

diff --git a/src/java/org/apache/poi/util/CodePageUtil.java b/src/java/org/apache/poi/util/CodePageUtil.java
index c8a629f44729ace579984b84a1512f7ba8bc6103..02e0ed3c0c6a42cb41b4c1869d05ba5b56f87caa 100644 (file)
--- a/src/java/org/apache/poi/util/CodePageUtil.java
+++ b/src/java/org/apache/poi/util/CodePageUtil.java
@@ -263,7 +263,7 @@ public class CodePageUtil
      * @return The character encoding's name, in either Java Lang format 
      *  (eg Cp1251, ISO8859_5) or Java NIO format (eg windows-1252, ISO-8859-9)
      *  
-     * See <a href="http://docs.oracle.com/javase/6/docs/technotes/guides/intl/encoding.doc.html">Encodings supported by Java</a>
+     * @see <a href="http://docs.oracle.com/javase/6/docs/technotes/guides/intl/encoding.doc.html">Supported Encodings</a>
      *
      * @exception UnsupportedEncodingException if the specified codepage is
      * less than zero.

diff --git a/src/ooxml/java/org/apache/poi/poifs/crypt/agile/AgileDecryptor.java b/src/ooxml/java/org/apache/poi/poifs/crypt/agile/AgileDecryptor.java
index 193e7a766b2891634504b60bbaff0a0ca643e3b1..ccd930853b281e684c158f55694d160dd14c8749 100644 (file)
--- a/src/ooxml/java/org/apache/poi/poifs/crypt/agile/AgileDecryptor.java
+++ b/src/ooxml/java/org/apache/poi/poifs/crypt/agile/AgileDecryptor.java
@@ -198,11 +198,11 @@ public class AgileDecryptor extends Decryptor {
      * instead of a password, it's also possible to decrypt via certificate.
      * Warning: this code is experimental and hasn't been validated
      * 
-     * {@linkplain http://social.msdn.microsoft.com/Forums/en-US/cc9092bb-0c82-4b5b-ae21-abf643bdb37c/agile-encryption-with-certificates}
+     * @see <a href="http://social.msdn.microsoft.com/Forums/en-US/cc9092bb-0c82-4b5b-ae21-abf643bdb37c/agile-encryption-with-certificates">Agile encryption with certificates</a>
      *
      * @param keyPair
      * @param x509
-     * @return
+     * @return true, when the data can be successfully decrypted with the given private key
      * @throws GeneralSecurityException
      */
     public boolean verifyPassword(KeyPair keyPair, X509Certificate x509) throws GeneralSecurityException {

diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextRun.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextRun.java
index c6f0591704b5acf721b89faae8bcf44c022f73be..16d0e803b1e8673aa2ff2d5016e98ab6b3cb88b0 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextRun.java
+++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextRun.java
@@ -16,6 +16,12 @@
 ==================================================================== */\r
 package org.apache.poi.xslf.usermodel;\r
 \r
+import java.awt.Color;\r
+import java.awt.font.FontRenderContext;\r
+import java.awt.font.TextAttribute;\r
+import java.awt.font.TextLayout;\r
+import java.text.AttributedString;\r
+\r
 import org.apache.poi.util.Beta;\r
 import org.apache.poi.xslf.model.CharacterPropertyFetcher;\r
 import org.openxmlformats.schemas.drawingml.x2006.main.CTRegularTextRun;\r
@@ -27,17 +33,11 @@ import org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties
 import org.openxmlformats.schemas.drawingml.x2006.main.CTTextFont;\r
 import org.openxmlformats.schemas.drawingml.x2006.main.CTTextNormalAutofit;\r
 import org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraphProperties;\r
+import org.openxmlformats.schemas.drawingml.x2006.main.STSchemeColorVal;\r
 import org.openxmlformats.schemas.drawingml.x2006.main.STTextStrikeType;\r
 import org.openxmlformats.schemas.drawingml.x2006.main.STTextUnderlineType;\r
-import org.openxmlformats.schemas.drawingml.x2006.main.STSchemeColorVal;\r
 import org.openxmlformats.schemas.presentationml.x2006.main.CTPlaceholder;\r
 \r
-import java.awt.Color;\r
-import java.awt.font.FontRenderContext;\r
-import java.awt.font.TextLayout;\r
-import java.awt.font.TextAttribute;\r
-import java.text.AttributedString;\r
-\r
 /**\r
  * Represents a run of text within the containing text body. The run element is the\r
  * lowest level text separation mechanism within a text body.\r
@@ -90,8 +90,6 @@ public class XSLFTextRun {
 \r
     /**\r
      * Replace a tab with the effective number of white spaces.\r
-     *\r
-     * @return\r
      */\r
     private String tab2space(){\r
         AttributedString string = new AttributedString(" ");\r

diff --git a/src/ooxml/java/org/apache/poi/xssf/extractor/XSSFExportToXml.java b/src/ooxml/java/org/apache/poi/xssf/extractor/XSSFExportToXml.java
index 80b0c34deba743515c953e68589fffcfe469f7dd..aa68c2638491243823645616cb7774def38afc86 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/extractor/XSSFExportToXml.java
+++ b/src/ooxml/java/org/apache/poi/xssf/extractor/XSSFExportToXml.java
@@ -249,7 +249,7 @@ public class XSSFExportToXml implements Comparator<String>{
      * Validate the generated XML against the XML Schema associated with the XSSFMap
      *
      * @param xml the XML to validate
-     * @return
+     * @return true, if document is valid
      */
     private boolean isValid(Document xml) throws SAXException{
         boolean isValid = false;

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java
index d24bd01e6d4f872c5eecbc98fa30dafbba4d15b8..44fc91bbf903ccc21aea315c4b15ac4e536ab887 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java
@@ -21,16 +21,36 @@ import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
 
-
 import org.apache.poi.hssf.util.HSSFColor;
-import org.openxmlformats.schemas.drawingml.x2006.main.*;
+import org.apache.poi.ss.usermodel.VerticalAlignment;
+import org.apache.poi.util.Internal;
+import org.apache.poi.util.Units;
+import org.openxmlformats.schemas.drawingml.x2006.main.CTNonVisualDrawingProps;
+import org.openxmlformats.schemas.drawingml.x2006.main.CTPoint2D;
+import org.openxmlformats.schemas.drawingml.x2006.main.CTPositiveSize2D;
+import org.openxmlformats.schemas.drawingml.x2006.main.CTPresetGeometry2D;
+import org.openxmlformats.schemas.drawingml.x2006.main.CTRegularTextRun;
+import org.openxmlformats.schemas.drawingml.x2006.main.CTSRgbColor;
+import org.openxmlformats.schemas.drawingml.x2006.main.CTShapeProperties;
+import org.openxmlformats.schemas.drawingml.x2006.main.CTSolidColorFillProperties;
+import org.openxmlformats.schemas.drawingml.x2006.main.CTTextBody;
+import org.openxmlformats.schemas.drawingml.x2006.main.CTTextBodyProperties;
+import org.openxmlformats.schemas.drawingml.x2006.main.CTTextCharacterProperties;
+import org.openxmlformats.schemas.drawingml.x2006.main.CTTextFont;
+import org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraph;
+import org.openxmlformats.schemas.drawingml.x2006.main.CTTransform2D;
+import org.openxmlformats.schemas.drawingml.x2006.main.STShapeType;
+import org.openxmlformats.schemas.drawingml.x2006.main.STTextAlignType;
+import org.openxmlformats.schemas.drawingml.x2006.main.STTextAnchoringType;
+import org.openxmlformats.schemas.drawingml.x2006.main.STTextHorzOverflowType;
+import org.openxmlformats.schemas.drawingml.x2006.main.STTextUnderlineType;
+import org.openxmlformats.schemas.drawingml.x2006.main.STTextVertOverflowType;
+import org.openxmlformats.schemas.drawingml.x2006.main.STTextVerticalType;
+import org.openxmlformats.schemas.drawingml.x2006.main.STTextWrappingType;
 import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShape;
 import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShapeNonVisual;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRElt;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTRPrElt;
-import org.apache.poi.util.Internal;
-import org.apache.poi.util.Units;
-import org.apache.poi.ss.usermodel.VerticalAlignment;
 import org.openxmlformats.schemas.spreadsheetml.x2006.main.STUnderlineValues;
 
 /**
@@ -244,7 +264,7 @@ public class XSSFSimpleShape extends XSSFShape implements Iterable<XSSFTextParag
      * Returns a string containing an appropriate prefix for an auto-numbering bullet
      * @param scheme the auto-numbering scheme used by the bullet
      * @param value the value of the bullet
-     * @return
+     * @return appropriate prefix for an auto-numbering bullet
      */
     private String getBulletPrefix(ListAutoNumber scheme, int value){
         StringBuilder out = new StringBuilder();