You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ki...@apache.org on 2013/12/25 23:18:53 UTC
svn commit: r1553422 - in /poi/trunk/src:
java/org/apache/poi/hssf/usermodel/ java/org/apache/poi/poifs/crypt/
java/org/apache/poi/poifs/property/
java/org/apache/poi/ss/formula/functions/ java/org/apache/poi/util/
ooxml/java/org/apache/poi/poifs/crypt...
Author: kiwiwings
Date: Wed Dec 25 22:18:53 2013
New Revision: 1553422
URL: http://svn.apache.org/r1553422
Log:
javadoc house-keeping
Modified:
poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFPatriarch.java
poi/trunk/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java
poi/trunk/src/java/org/apache/poi/poifs/property/NPropertyTable.java
poi/trunk/src/java/org/apache/poi/ss/formula/functions/Complex.java
poi/trunk/src/java/org/apache/poi/ss/formula/functions/Mirr.java
poi/trunk/src/java/org/apache/poi/ss/formula/functions/Roman.java
poi/trunk/src/java/org/apache/poi/util/CodePageUtil.java
poi/trunk/src/ooxml/java/org/apache/poi/poifs/crypt/agile/AgileDecryptor.java
poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextRun.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/extractor/XSSFExportToXml.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java
Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFPatriarch.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFPatriarch.java?rev=1553422&r1=1553421&r2=1553422&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFPatriarch.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFPatriarch.java Wed Dec 25 22:18:53 2013
@@ -45,6 +45,7 @@ import org.apache.poi.hssf.record.ObjRec
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 impleme
*
* @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.
*
Modified: poi/trunk/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java?rev=1553422&r1=1553421&r2=1553422&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java (original)
+++ poi/trunk/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java Wed Dec 25 22:18:53 2013
@@ -65,13 +65,13 @@ public class CryptoFunctions {
* monotonically on each iteration until PasswordKey.spinCount iterations have been performed.
* The value of iterator on the last iteration MUST be one less than PasswordKey.spinCount.
*
- * For POI, H_final will be calculated by {@link generateKey()}
+ * For POI, H_final will be calculated by {@link #generateKey(byte[],HashAlgorithm,byte[],int)}
*
* @param password
* @param hashAlgorithm
* @param salt
* @param spinCount
- * @return
+ * @return the hashed password
*/
public static byte[] hashPassword(String password, HashAlgorithm hashAlgorithm, byte salt[], int spinCount) {
// If no password was given, use the default
@@ -146,7 +146,7 @@ public class CryptoFunctions {
* @param hashAlgorithm
* @param blockKey
* @param keySize
- * @return
+ * @return intermediate key
*/
public static byte[] generateKey(byte[] passwordHash, HashAlgorithm hashAlgorithm, byte[] blockKey, int keySize) {
MessageDigest hashAlgo = getMessageDigest(hashAlgorithm);
@@ -166,7 +166,7 @@ public class CryptoFunctions {
* @param chain
* @param vec
* @param cipherMode Cipher.DECRYPT_MODE or Cipher.ENCRYPT_MODE
- * @return
+ * @return the requested cipher
* @throws GeneralSecurityException
*/
public static Cipher getCipher(SecretKey key, CipherAlgorithm cipherAlgorithm, ChainingMode chain, byte[] vec, int cipherMode, String padding) {
Modified: poi/trunk/src/java/org/apache/poi/poifs/property/NPropertyTable.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/poifs/property/NPropertyTable.java?rev=1553422&r1=1553421&r2=1553422&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/poifs/property/NPropertyTable.java (original)
+++ poi/trunk/src/java/org/apache/poi/poifs/property/NPropertyTable.java Wed Dec 25 22:18:53 2013
@@ -77,7 +77,6 @@ public final class NPropertyTable extend
* Builds
* @param startAt
* @param filesystem
- * @return
* @throws IOException
*/
private static List<Property> buildProperties(final Iterator<ByteBuffer> dataSource,
Modified: poi/trunk/src/java/org/apache/poi/ss/formula/functions/Complex.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/functions/Complex.java?rev=1553422&r1=1553421&r2=1553422&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/formula/functions/Complex.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/formula/functions/Complex.java Wed Dec 25 22:18:53 2013
@@ -18,7 +18,11 @@
package org.apache.poi.ss.formula.functions;
import org.apache.poi.ss.formula.OperationEvaluationContext;
-import org.apache.poi.ss.formula.eval.*;
+import org.apache.poi.ss.formula.eval.ErrorEval;
+import org.apache.poi.ss.formula.eval.EvaluationException;
+import org.apache.poi.ss.formula.eval.OperandResolver;
+import org.apache.poi.ss.formula.eval.StringEval;
+import org.apache.poi.ss.formula.eval.ValueEval;
/**
* Implementation for Excel COMPLEX () function.<p/>
@@ -126,10 +130,6 @@ public class Complex extends Var2or3ArgF
return new StringEval(strb.toString());
}
- /**
- * @param number
- * @return
- */
private boolean isDoubleAnInt(double number) {
return (number == Math.floor(number)) && !Double.isInfinite(number);
}
Modified: poi/trunk/src/java/org/apache/poi/ss/formula/functions/Mirr.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/functions/Mirr.java?rev=1553422&r1=1553421&r2=1553422&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/formula/functions/Mirr.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/formula/functions/Mirr.java Wed Dec 25 22:18:53 2013
@@ -41,7 +41,7 @@ import org.apache.poi.ss.formula.eval.Ev
*
* @see <a href="http://en.wikipedia.org/wiki/MIRR">Wikipedia on MIRR</a>
* @see <a href="http://office.microsoft.com/en-001/excel-help/mirr-HP005209180.aspx">Excel MIRR</a>
- * @see {@link Irr}
+ * @see Irr
*/
public class Mirr extends MultiOperandNumericFunction {
Modified: poi/trunk/src/java/org/apache/poi/ss/formula/functions/Roman.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/functions/Roman.java?rev=1553422&r1=1553421&r2=1553422&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/formula/functions/Roman.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/formula/functions/Roman.java Wed Dec 25 22:18:53 2013
@@ -17,7 +17,11 @@
package org.apache.poi.ss.formula.functions;
-import org.apache.poi.ss.formula.eval.*;
+import org.apache.poi.ss.formula.eval.ErrorEval;
+import org.apache.poi.ss.formula.eval.EvaluationException;
+import org.apache.poi.ss.formula.eval.OperandResolver;
+import org.apache.poi.ss.formula.eval.StringEval;
+import org.apache.poi.ss.formula.eval.ValueEval;
/**
* Implementation for Excel WeekNum() function.<p/>
@@ -87,7 +91,6 @@ public class Roman extends Fixed2ArgFunc
* Classic conversion.
*
* @param number
- * @return
*/
private String integerToRoman(int number) {
StringBuilder result = new StringBuilder();
@@ -105,7 +108,6 @@ public class Roman extends Fixed2ArgFunc
*
* @param result
* @param form
- * @return
*/
public String makeConcise(String result, int form) {
if (form > 0) {
Modified: poi/trunk/src/java/org/apache/poi/util/CodePageUtil.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/util/CodePageUtil.java?rev=1553422&r1=1553421&r2=1553422&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/util/CodePageUtil.java (original)
+++ poi/trunk/src/java/org/apache/poi/util/CodePageUtil.java Wed Dec 25 22:18:53 2013
@@ -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.
Modified: poi/trunk/src/ooxml/java/org/apache/poi/poifs/crypt/agile/AgileDecryptor.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/poifs/crypt/agile/AgileDecryptor.java?rev=1553422&r1=1553421&r2=1553422&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/poifs/crypt/agile/AgileDecryptor.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/poifs/crypt/agile/AgileDecryptor.java Wed Dec 25 22:18:53 2013
@@ -198,11 +198,11 @@ public class AgileDecryptor extends Decr
* 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 {
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextRun.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextRun.java?rev=1553422&r1=1553421&r2=1553422&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextRun.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextRun.java Wed Dec 25 22:18:53 2013
@@ -16,6 +16,12 @@
==================================================================== */
package org.apache.poi.xslf.usermodel;
+import java.awt.Color;
+import java.awt.font.FontRenderContext;
+import java.awt.font.TextAttribute;
+import java.awt.font.TextLayout;
+import java.text.AttributedString;
+
import org.apache.poi.util.Beta;
import org.apache.poi.xslf.model.CharacterPropertyFetcher;
import org.openxmlformats.schemas.drawingml.x2006.main.CTRegularTextRun;
@@ -27,17 +33,11 @@ import org.openxmlformats.schemas.drawin
import org.openxmlformats.schemas.drawingml.x2006.main.CTTextFont;
import org.openxmlformats.schemas.drawingml.x2006.main.CTTextNormalAutofit;
import org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraphProperties;
+import org.openxmlformats.schemas.drawingml.x2006.main.STSchemeColorVal;
import org.openxmlformats.schemas.drawingml.x2006.main.STTextStrikeType;
import org.openxmlformats.schemas.drawingml.x2006.main.STTextUnderlineType;
-import org.openxmlformats.schemas.drawingml.x2006.main.STSchemeColorVal;
import org.openxmlformats.schemas.presentationml.x2006.main.CTPlaceholder;
-import java.awt.Color;
-import java.awt.font.FontRenderContext;
-import java.awt.font.TextLayout;
-import java.awt.font.TextAttribute;
-import java.text.AttributedString;
-
/**
* Represents a run of text within the containing text body. The run element is the
* lowest level text separation mechanism within a text body.
@@ -90,8 +90,6 @@ public class XSLFTextRun {
/**
* Replace a tab with the effective number of white spaces.
- *
- * @return
*/
private String tab2space(){
AttributedString string = new AttributedString(" ");
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/extractor/XSSFExportToXml.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/extractor/XSSFExportToXml.java?rev=1553422&r1=1553421&r2=1553422&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/extractor/XSSFExportToXml.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/extractor/XSSFExportToXml.java Wed Dec 25 22:18:53 2013
@@ -249,7 +249,7 @@ public class XSSFExportToXml implements
* 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;
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java?rev=1553422&r1=1553421&r2=1553422&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSimpleShape.java Wed Dec 25 22:18:53 2013
@@ -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 XSS
* 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();
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org