javadoc house-keeping

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

4 files changed, 36 insertions, 18 deletions

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 193e7a766b..ccd930853b 100644
--- 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 c6f0591704..16d0e803b1 100644
--- 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 @@
 ==================================================================== */

 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.drawingml.x2006.main.CTTextCharacterProperties
 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(" ");

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 80b0c34deb..aa68c26384 100644
--- 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 d24bd01e6d..44fc91bbf9 100644
--- 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();