From b2e18cf5ed525be1cf0559a1c53d58a08957c95e Mon Sep 17 00:00:00 2001 From: Andreas Beeker Date: Sun, 26 Jul 2015 00:25:27 +0000 Subject: [PATCH] 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 | 5 ++--- src/java/org/apache/poi/sl/usermodel/GroupShape.java | 2 +- src/java/org/apache/poi/sl/usermodel/ShapeContainer.java | 2 +- src/java/org/apache/poi/sl/usermodel/TextParagraph.java | 2 +- .../java/org/apache/poi/xslf/usermodel/XSLFShape.java | 7 +++---- .../org/apache/poi/xslf/usermodel/XSLFTextParagraph.java | 4 ++-- .../hslf/model/textproperties/TabStopPropCollection.java | 1 - .../src/org/apache/poi/hslf/record/TextHeaderAtom.java | 2 +- .../src/org/apache/poi/hslf/usermodel/HSLFGroupShape.java | 2 +- .../org/apache/poi/hslf/usermodel/HSLFPictureShape.java | 7 +++---- .../org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.java | 2 +- .../src/org/apache/poi/hslf/usermodel/HSLFTableCell.java | 2 +- .../src/org/apache/poi/hslf/usermodel/HSLFTextRun.java | 2 +- 13 files changed, 18 insertions(+), 22 deletions(-) diff --git a/src/java/org/apache/poi/sl/draw/DrawPaint.java b/src/java/org/apache/poi/sl/draw/DrawPaint.java index 16562b82a..26a94ed34 100644 --- a/src/java/org/apache/poi/sl/draw/DrawPaint.java +++ b/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 Java Tips Weblog + * @see HSL code taken from Java Tips Weblog */ 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 Using Office Open XML to Customize Document Formatting in the 2007 Office System diff --git a/src/java/org/apache/poi/sl/usermodel/GroupShape.java b/src/java/org/apache/poi/sl/usermodel/GroupShape.java index d71bb253f..8133ac048 100644 --- a/src/java/org/apache/poi/sl/usermodel/GroupShape.java +++ b/src/java/org/apache/poi/sl/usermodel/GroupShape.java @@ -25,7 +25,7 @@ public interface GroupShape extends Shape, ShapeContainer, 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(); diff --git a/src/java/org/apache/poi/sl/usermodel/ShapeContainer.java b/src/java/org/apache/poi/sl/usermodel/ShapeContainer.java index 1741a732d..0172fa770 100644 --- a/src/java/org/apache/poi/sl/usermodel/ShapeContainer.java +++ b/src/java/org/apache/poi/sl/usermodel/ShapeContainer.java @@ -37,7 +37,7 @@ public interface ShapeContainer extends Iterable { * (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 true if this sheet contained the specified element * @throws IllegalArgumentException if the type of the specified shape * is incompatible with this sheet (optional) diff --git a/src/java/org/apache/poi/sl/usermodel/TextParagraph.java b/src/java/org/apache/poi/sl/usermodel/TextParagraph.java index a914dd7cb..0b2eb062c 100644 --- a/src/java/org/apache/poi/sl/usermodel/TextParagraph.java +++ b/src/java/org/apache/poi/sl/usermodel/TextParagraph.java @@ -279,7 +279,7 @@ public interface TextParagraph extends Iterable { * paragraph.setLineSpacing(-48.0); * * - * @param linespacing the vertical line spacing + * @param lineSpacing the vertical line spacing */ void setLineSpacing(Double lineSpacing); diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFShape.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFShape.java index 2e169638f..3ea1d3a7c 100644 --- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFShape.java +++ b/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 selectProperty(Class 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: * * a:scrgbClr RGB Color Model - Percentage Variant diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextParagraph.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextParagraph.java index 45000a1c3..f9bad78be 100644 --- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextParagraph.java +++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFTextParagraph.java @@ -144,7 +144,7 @@ public class XSLFTextParagraph implements TextParagraph { * 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 { /** * 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 */ diff --git a/src/scratchpad/src/org/apache/poi/hslf/model/textproperties/TabStopPropCollection.java b/src/scratchpad/src/org/apache/poi/hslf/model/textproperties/TabStopPropCollection.java index 786b37338..366886217 100644 --- a/src/scratchpad/src/org/apache/poi/hslf/model/textproperties/TabStopPropCollection.java +++ b/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); diff --git a/src/scratchpad/src/org/apache/poi/hslf/record/TextHeaderAtom.java b/src/scratchpad/src/org/apache/poi/hslf/record/TextHeaderAtom.java index a63d8934d..3fab236a1 100644 --- a/src/scratchpad/src/org/apache/poi/hslf/record/TextHeaderAtom.java +++ b/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; } diff --git a/src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFGroupShape.java b/src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFGroupShape.java index ae343f22c..12c0167ad 100644 --- a/src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFGroupShape.java +++ b/src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFGroupShape.java @@ -212,7 +212,7 @@ public class HSLFGroupShape extends HSLFShape implements GroupShape { /** * 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. */ diff --git a/src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFPictureShape.java b/src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFPictureShape.java index 5db610af0..a6857937c 100644 --- a/src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFPictureShape.java +++ b/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); diff --git a/src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.java b/src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.java index 34638f630..c02fe22c9 100644 --- a/src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFSlideShowImpl.java +++ b/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. diff --git a/src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFTableCell.java b/src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFTableCell.java index b1e7c3e4b..74abd1903 100644 --- a/src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFTableCell.java +++ b/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 parent){ diff --git a/src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFTextRun.java b/src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFTextRun.java index 8728eabb6..08565e3da 100644 --- a/src/scratchpad/src/org/apache/poi/hslf/usermodel/HSLFTextRun.java +++ b/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;