Javadoc fixes

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

src/java/org/apache/poi/sl/draw/DrawPaint.java

@@ -37,7 +37,7 @@ import org.apache.poi.util.POILogger;
 /**
  * This class handles color transformations
  * 
- * @see HSL code taken from <a href="https://tips4java.wordpress.com/2009/07/05/hsl-color/">Java Tips Weblog</a>
+ * @see <a href="https://tips4java.wordpress.com/2009/07/05/hsl-color/">HSL code taken from Java Tips Weblog</a>
  */
 public class DrawPaint {
     // HSL code is public domain - see https://tips4java.wordpress.com/contact-us/
@@ -147,8 +147,7 @@ public class DrawPaint {
      * Apply lumMod / lumOff adjustments
      *
      * @param c the color to modify
-     * @param lumMod luminance modulation in the range [0..100000]
-     * @param lumOff luminance offset in the range [0..100000]
+     * @param fc the color style containing the lumMod / lumOff adjustments
      * @return  modified color
      * 
      * @see <a href="https://msdn.microsoft.com/en-us/library/dd560821%28v=office.12%29.aspx">Using Office Open XML to Customize Document Formatting in the 2007 Office System</a>

src/java/org/apache/poi/sl/usermodel/GroupShape.java

@@ -25,7 +25,7 @@ public interface GroupShape<T extends Shape> extends Shape, ShapeContainer<T>, P
      * Gets the coordinate space of this group.  All children are constrained
      * to these coordinates.
      *
-     * @param anchor the coordinate space of this group
+     * @return the coordinate space of this group
      */
     Rectangle2D getInteriorAnchor();
     

src/java/org/apache/poi/sl/usermodel/ShapeContainer.java

@@ -37,7 +37,7 @@ public interface ShapeContainer<T extends Shape> extends Iterable<T> {
      * (optional operation).  If this sheet does not contain the element,
      * it is unchanged.
      *
-     * @param xShape shape to be removed from this sheet, if present
+     * @param shape the shape to be removed from this sheet, if present
      * @return <tt>true</tt> if this sheet contained the specified element
      * @throws IllegalArgumentException if the type of the specified shape
      *         is incompatible with this sheet (optional)

src/java/org/apache/poi/sl/usermodel/TextParagraph.java

@@ -279,7 +279,7 @@ public interface TextParagraph<T extends TextRun> extends Iterable<T> {
      *      paragraph.setLineSpacing(-48.0);
      * </code></pre>
      * 
-     * @param linespacing the vertical line spacing
+     * @param lineSpacing the vertical line spacing
      */
     void setLineSpacing(Double lineSpacing);
 

src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFShape.java

@@ -271,9 +271,9 @@ public abstract class XSLFShape implements Shape {
      * properties. This method is the generalized form of selecting and casting those
      * properties.
      *
-     * @param resultClass
-     * @param xquery
-     * @return
+     * @param resultClass the requested result class
+     * @param xquery the simple (xmlbean) xpath expression to the property
+     * @return the xml object at the xpath location, or null if not found
      */
     @SuppressWarnings("unchecked")
     protected <T extends XmlObject> T selectProperty(Class<T> resultClass, String xquery) {
@@ -354,7 +354,6 @@ public abstract class XSLFShape implements Shape {
      * Convert shape fill into java.awt.Paint. The result is either Color or
      * TexturePaint or GradientPaint or null
      *
-     * @param graphics  the target graphics
      * @param obj       the xml to read. Must contain elements from the EG_ColorChoice group:
      * <code>
      *     a:scrgbClr    RGB Color Model - Percentage Variant

src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextParagraph.java

@@ -144,7 +144,7 @@ public class XSLFTextParagraph implements TextParagraph<XSLFTextRun> {
      * Returns the alignment that is applied to the paragraph.
      *
      * If this attribute is omitted, then null is returned.
-     * User code can imply the value {@link TextAlign#LEFT} then.
+     * User code can imply the value {@link org.apache.poi.sl.usermodel.TextParagraph.TextAlign#LEFT} then.
      *
      * @return alignment that is applied to the paragraph
      */
@@ -166,7 +166,7 @@ public class XSLFTextParagraph implements TextParagraph<XSLFTextRun> {
     /**
      * Specifies the alignment that is to be applied to the paragraph.
      * Possible values for this include left, right, centered, justified and distributed,
-     * see {@link org.apache.poi.sl.usermodel.TextAlign}.
+     * see {@link org.apache.poi.sl.usermodel.TextParagraph.TextAlign}.
      *
      * @param align text align
      */

src/scratchpad/src/org/apache/poi/hslf/model/textproperties/TabStopPropCollection.java

@@ -90,7 +90,6 @@ public class TabStopPropCollection extends TextProp {
      *
      * @param data the data stream
      * @param offset the offset within the data
-     * @return the new offset
      */
     public void parseProperty(byte data[], int offset) {
         int count = LittleEndian.getUShort(data, offset);

src/scratchpad/src/org/apache/poi/hslf/record/TextHeaderAtom.java

@@ -58,7 +58,7 @@ public final class TextHeaderAtom extends RecordAtom implements ParentAwareRecor
 	public int getIndex() { return index; }
 
     /**
-     *  @param id 0-based index of the text run in the SLWT container
+     *  @param index 0-based index of the text run in the SLWT container
      */
 	public void setIndex(int index) { this.index = index; }
 

src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFGroupShape.java

@@ -212,7 +212,7 @@ public class HSLFGroupShape extends HSLFShape implements GroupShape<HSLFShape> {
 
     /**
      * Return type of the shape.
-     * In most cases shape group type is {@link org.apache.poi.hslf.model.ShapeTypes#NotPrimitive}
+     * In most cases shape group type is {@link org.apache.poi.sl.usermodel.ShapeType#NOT_PRIMITIVE}
      *
      * @return type of the shape.
      */

src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFPictureShape.java

@@ -253,12 +253,11 @@ public class HSLFPictureShape extends HSLFSimpleShape implements PictureShape {
         }
     }
 
-    /**
-     * The anchor specified by {@link #getLogicalAnchor2D()} is the displayed size,
-     * i.e. the size of the already clipped image
-     */
+
     @Override
     public Insets getClipping() {
+        // The anchor specified by the escher properties is the displayed size,
+        // i.e. the size of the already clipped image
         EscherOptRecord opt = getEscherOptRecord();
         
         double top    = getFractProp(opt, EscherProperties.BLIP__CROPFROMTOP);

src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.java

@@ -144,7 +144,7 @@ public final class HSLFSlideShowImpl extends POIDocument {
     *  POIFS Filesystem. Parses the document and places all the
     *  important stuff into data structures.
     *
-    * @deprecated Use {@link #HSLFSlideShow(DirectoryNode)} instead
+    * @deprecated Use {@link #HSLFSlideShowImpl(DirectoryNode)} instead
     * @param dir the POIFS directory to read from
     * @param filesystem the POIFS FileSystem to read from
     * @throws IOException if there is a problem while parsing the document.

src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFTableCell.java

@@ -43,7 +43,7 @@ public final class HSLFTableCell extends HSLFTextBox {
     /**
      * Create a TableCell object and initialize it from the supplied Record container.
      *
-     * @param escherRecord       {@link EscherSpContainer} container which holds information about this shape
+     * @param escherRecord       EscherSpContainer which holds information about this shape
      * @param parent    the parent of the shape
      */
    protected HSLFTableCell(EscherContainerRecord escherRecord, ShapeContainer<HSLFShape> parent){

src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFTextRun.java

@@ -48,7 +48,7 @@ public final class HSLFTextRun implements TextRun {
 
 	/**
 	 * Create a new wrapper around a rich text string
-	 * @param parent The parent paragraph
+	 * @param parentParagraph the parent paragraph
 	 */
 	public HSLFTextRun(HSLFTextParagraph parentParagraph) {
 		this.parentParagraph = parentParagraph;