fixed javadoc warnings

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

12 files changed, 24 insertions, 26 deletions

diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/RenderableShape.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/RenderableShape.java
index b46ae8b2bc..1d3ed4e11e 100644
--- a/src/ooxml/java/org/apache/poi/xslf/usermodel/RenderableShape.java
+++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/RenderableShape.java
@@ -65,7 +65,6 @@ import java.util.ArrayList;
 import java.util.Arrays;

 import java.util.Collection;

 import java.util.Comparator;

-import java.util.List;

 

 /**

  * Encapsulates logic to translate DrawingML objects to Java2D

@@ -142,10 +141,10 @@ class RenderableShape {
         String blipId = blip.getEmbed();

         PackageRelationship rel = parentPart.getRelationship(blipId);

         if (rel != null) {

-            XSLFImageRendener renderer = null;

+            XSLFImageRenderer renderer = null;

             if (graphics != null)

-                renderer = (XSLFImageRendener) graphics.getRenderingHint(XSLFRenderingHint.IMAGE_RENDERER);

-            if (renderer == null) renderer = new XSLFImageRendener();

+                renderer = (XSLFImageRenderer) graphics.getRenderingHint(XSLFRenderingHint.IMAGE_RENDERER);

+            if (renderer == null) renderer = new XSLFImageRenderer();

 

             try {

                 BufferedImage img = renderer.readImage(parentPart.getRelatedPart(rel));

diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFConnectorShape.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFConnectorShape.java
index 3f7d88b870..4018d4d214 100644
--- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFConnectorShape.java
+++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFConnectorShape.java
@@ -77,8 +77,7 @@ public class XSLFConnectorShape extends XSLFSimpleShape {
 

 

     /**

-     * YK: dashing of lines is suppressed for now.

-     * @return

+     * YK: shadows of lines are suppressed for now.

      */

     @Override

     public XSLFShadow getShadow() {

diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFFontManager.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFFontManager.java
index e61933fb37..cc5fc6c2d5 100644
--- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFFontManager.java
+++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFFontManager.java
@@ -29,7 +29,7 @@ public interface XSLFFontManager {
     /**

      * select a font to be used to paint text

      *

-     * @param family the font family as defined in the .pptx file.

+     * @param typeface the font family as defined in the .pptx file.

      * This can be unknown or missing in the graphic environment.

      *

      * @return the font to be used to paint text

diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFImageRendener.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFImageRenderer.java
index 06ba185135..f180aba207 100644
--- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFImageRendener.java
+++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFImageRenderer.java
@@ -39,7 +39,6 @@ import java.io.InputStream;
  * 

  * <pre>

  * <code>

- * @Override

  * public class MyImageRendener extends XSLFImageRendener{

  * public boolean drawImage(Graphics2D graphics, XSLFPictureData data, Rectangle2D anchor){

  * 	boolean ok = super.drawImage(graphics, data, anchor);

@@ -69,12 +68,12 @@ import java.io.InputStream;
  * @author Yegor Kozlov

  */

 @Beta

-public class XSLFImageRendener {

+public class XSLFImageRenderer {

 

 	/**

 	 * Render picture data into the supplied graphics

 	 * 

-	 * @return true if the picture data was succesfully renderered

+	 * @return true if the picture data was successfully rendered

 	 */

 	public boolean drawImage(Graphics2D graphics, XSLFPictureData data,

 			Rectangle2D anchor) {

diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java
index 75cc4d15d0..8ad48364ce 100644
--- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java
+++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFPictureShape.java
@@ -22,7 +22,6 @@ package org.apache.poi.xslf.usermodel;
 import org.apache.poi.POIXMLException;

 import org.apache.poi.openxml4j.opc.PackagePart;

 import org.apache.poi.openxml4j.opc.PackageRelationship;

-import org.apache.poi.openxml4j.opc.TargetMode;

 import org.apache.poi.util.Beta;

 import org.openxmlformats.schemas.drawingml.x2006.main.CTBlip;

 import org.openxmlformats.schemas.drawingml.x2006.main.CTBlipFillProperties;

@@ -126,8 +125,8 @@ public class XSLFPictureShape extends XSLFSimpleShape {
         XSLFPictureData data = getPictureData();

     	if(data == null) return;

 

-        XSLFImageRendener renderer = (XSLFImageRendener)graphics.getRenderingHint(XSLFRenderingHint.IMAGE_RENDERER);

-        if(renderer == null) renderer = new XSLFImageRendener();

+        XSLFImageRenderer renderer = (XSLFImageRenderer)graphics.getRenderingHint(XSLFRenderingHint.IMAGE_RENDERER);

+        if(renderer == null) renderer = new XSLFImageRenderer();

 

         RenderableShape rShape = new RenderableShape(this);

         Rectangle2D anchor = rShape.getAnchor(graphics);

diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFRenderingHint.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFRenderingHint.java
index 715530c67c..fe68385688 100644
--- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFRenderingHint.java
+++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFRenderingHint.java
@@ -44,7 +44,7 @@ public class XSLFRenderingHint extends RenderingHints.Key {
     /**

      * Use a custom image rendener

      *

-     * @see XSLFImageRendener

+     * @see XSLFImageRenderer

      */

     public static final XSLFRenderingHint IMAGE_RENDERER = new XSLFRenderingHint(3);

 

diff --git a/src/ooxml/java/org/apache/poi/xssf/streaming/SheetDataWriter.java b/src/ooxml/java/org/apache/poi/xssf/streaming/SheetDataWriter.java
index ec733a1c98..d575e05324 100644
--- a/src/ooxml/java/org/apache/poi/xssf/streaming/SheetDataWriter.java
+++ b/src/ooxml/java/org/apache/poi/xssf/streaming/SheetDataWriter.java
@@ -65,7 +65,6 @@ public class SheetDataWriter {
      * Create a writer for the sheet data.

      * 

      * @param  fd the file to write to

-     * @return

      */

     public Writer createWriter(File fd)throws IOException {

         return new BufferedWriter(new FileWriter(fd));

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
index 896be63bd0..0f8d3d70d0 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
@@ -558,12 +558,15 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable<X
      * The string MUST NOT begin or end with the single quote (') character.
      * </p>
      *
+     * <p>
+     * See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)}
+     *      for a safe way to create valid names
+     * </p>
      * @param sheetname  sheetname to set for the sheet.
      * @return Sheet representing the new sheet.
      * @throws IllegalArgumentException if the name is null or invalid
      *  or workbook already contains a sheet with this name
-     * @see {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)}
-     *      for a safe way to create valid names
+     * @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)
      */
     public XSSFSheet createSheet(String sheetname) {
         if (sheetname == null) {
@@ -1190,9 +1193,8 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable<X
      * @param sheetname  the new sheet name
      * @throws IllegalArgumentException if the name is null or invalid
      *  or workbook already contains a sheet with this name
-     * @see {@link #createSheet(String)}
-     * @see {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)}
-     *      for a safe way to create valid names
+     * @see #createSheet(String)
+     * @see org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)
      */
     public void setSheetName(int sheetIndex, String sheetname) {
         validateSheetIndex(sheetIndex);
diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/charts/XSSFManualLayout.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/charts/XSSFManualLayout.java
index 087dfb553d..273e674ae8 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/charts/XSSFManualLayout.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/charts/XSSFManualLayout.java
@@ -49,7 +49,7 @@ public final class XSSFManualLayout implements ManualLayout {
 

 	/**

 	 * Create a new SpreadsheetML manual layout.

-	 * @param layout a Spreadsheet ML layout that should be used as base.

+	 * @param ctLayout a Spreadsheet ML layout that should be used as base.

 	 */

 	public XSSFManualLayout(CTLayout ctLayout) {

 		initLayout(ctLayout);

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 c7d37d1bc5..6b4423ba8d 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
@@ -505,9 +505,10 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
 
     /**
      * 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.
+     * {@link org.apache.xmlbeans.XmlCursor.TokenType#START} tag of an subelement
+     * of the documents body. When this method is done, the cursor passed as
+     * parameter points to the {@link org.apache.xmlbeans.XmlCursor.TokenType#END}
+     * of the newly inserted paragraph.
      * 
      * @param cursor
      * @return the {@link XWPFParagraph} object representing the newly inserted
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnote.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnote.java
index 89b6ff1590..1977f9527f 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnote.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnote.java
@@ -81,7 +81,7 @@ public class XWPFFootnote implements Iterable<XWPFParagraph>,IBody {
     }
 
     /**
-     * @param position in table array
+     * @param pos in table array
      * @return The table at position pos
      * @see org.apache.poi.xwpf.usermodel.IBody#getTableArray(int)
      */
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java
index 27908901dd..93bc8bfc7b 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFFootnotes.java
@@ -132,7 +132,7 @@ public class XWPFFootnotes extends POIXMLDocumentPart {
 
 	/**
 	 * add a footnote to the document
-	 * @param footnote
+	 * @param note
 	 * @throws IOException		 
 	 */
 	public XWPFFootnote addFootnote(CTFtnEdn note){