diff options
Diffstat (limited to 'src/java')
23 files changed, 53 insertions, 61 deletions
diff --git a/src/java/org/apache/fop/apps/Fop.java b/src/java/org/apache/fop/apps/Fop.java index 171a6ce2f..b359e23b7 100644 --- a/src/java/org/apache/fop/apps/Fop.java +++ b/src/java/org/apache/fop/apps/Fop.java @@ -101,7 +101,7 @@ public class Fop implements Constants { /** * Constructor that creates a default FOUserAgent - * @see org.apache.fop.apps.Fop#(int, FOUserAgent) + * @see org.apache.fop.apps.Fop#Fop(int, FOUserAgent) */ public Fop(int renderType) { this(renderType, new FOUserAgent()); diff --git a/src/java/org/apache/fop/area/BookmarkData.java b/src/java/org/apache/fop/area/BookmarkData.java index 55efeae33..06c72d57b 100644 --- a/src/java/org/apache/fop/area/BookmarkData.java +++ b/src/java/org/apache/fop/area/BookmarkData.java @@ -53,7 +53,7 @@ public class BookmarkData extends OffDocumentItem implements Resolvable { * This should only be called by the bookmark-tree item because * it has no idref item that needs to be resolved. * - * @param bookmarks fo:bookmark-tree for this document + * @param bookmarkTree fo:bookmark-tree for this document */ public BookmarkData(BookmarkTree bookmarkTree) { idRef = null; diff --git a/src/java/org/apache/fop/area/CachedRenderPagesModel.java b/src/java/org/apache/fop/area/CachedRenderPagesModel.java index 6c3d1cc1a..d7c148c4e 100644 --- a/src/java/org/apache/fop/area/CachedRenderPagesModel.java +++ b/src/java/org/apache/fop/area/CachedRenderPagesModel.java @@ -46,7 +46,7 @@ public class CachedRenderPagesModel extends RenderPagesModel { /** * Constructor - * @see org.apache.fop.area.RenderPagesModel(FOUserAgent, int, FontInfo, OutputStream) + * @see org.apache.fop.area.RenderPagesModel#RenderPagesModel(FOUserAgent, int, FontInfo, OutputStream) */ public CachedRenderPagesModel (FOUserAgent userAgent, int renderType, FontInfo fontInfo, OutputStream stream) throws FOPException { diff --git a/src/java/org/apache/fop/area/LinkResolver.java b/src/java/org/apache/fop/area/LinkResolver.java index c3c0830d3..7874a0334 100644 --- a/src/java/org/apache/fop/area/LinkResolver.java +++ b/src/java/org/apache/fop/area/LinkResolver.java @@ -61,7 +61,7 @@ public class LinkResolver implements Resolvable, Serializable { /** * Resolve by adding an internal link. * - * @see org.apache.fop.area.Resolveable#resolveIDRef(String, List) + * @see org.apache.fop.area.Resolvable#resolveIDRef(String, List) */ public void resolveIDRef(String id, List pages) { if (idRef.equals(id) && pages != null) { diff --git a/src/java/org/apache/fop/area/MainReference.java b/src/java/org/apache/fop/area/MainReference.java index 52660b61d..7ae288f90 100644 --- a/src/java/org/apache/fop/area/MainReference.java +++ b/src/java/org/apache/fop/area/MainReference.java @@ -68,19 +68,18 @@ public class MainReference extends Area { } /** - * Get the span area currently being filled (i.e., the last span created) - * - * @return the active span + * Get the span area currently being filled (i.e., the last span created). + * @return the active span. */ public Span getCurrentSpan() { return (Span) spanAreas.get(spanAreas.size()-1); } /** - * indicates whether any child areas have been added to this reference area - * this is achieved by looping through each span + * Indicates whether any child areas have been added to this reference area. * - * @return + * This is achieved by looping through each span. + * @return true if no child areas have been added yet. */ public boolean isEmpty() { if (isEmpty) { diff --git a/src/java/org/apache/fop/area/PageViewport.java b/src/java/org/apache/fop/area/PageViewport.java index 4fedd05c6..263524083 100644 --- a/src/java/org/apache/fop/area/PageViewport.java +++ b/src/java/org/apache/fop/area/PageViewport.java @@ -153,7 +153,7 @@ public class PageViewport implements Resolvable, Cloneable { * to unresolvedIDRefs, for subsequent resolution by AreaTreeHandler * calls to this object's resolveIDRef(). * - * @param id the idref + * @param idref the idref * @param res the child element of this page that needs this * idref resolved */ @@ -188,7 +188,7 @@ public class PageViewport implements Resolvable, Cloneable { } /** - * @see org.apache.fop.area.Resolveable#resolveIDRef(String, List) + * @see org.apache.fop.area.Resolvable#resolveIDRef(String, List) */ public void resolveIDRef(String id, List pages) { if (page == null) { @@ -516,4 +516,4 @@ public class PageViewport implements Resolvable, Cloneable { public RegionReference getRegionReference(int id) { return getPage().getRegionViewport(id).getRegionReference(); } -}
\ No newline at end of file +} diff --git a/src/java/org/apache/fop/area/RegionReference.java b/src/java/org/apache/fop/area/RegionReference.java index 7fdbd183e..a3523d7ec 100644 --- a/src/java/org/apache/fop/area/RegionReference.java +++ b/src/java/org/apache/fop/area/RegionReference.java @@ -44,7 +44,8 @@ public class RegionReference extends Area implements Cloneable { /** * Create a new region reference area. * - * @param type the region class type + * @param regionFO the region. + * @param parent the viewport for this region. */ public RegionReference(Region regionFO, RegionViewport parent) { this.regionFO = regionFO; diff --git a/src/java/org/apache/fop/datatypes/CompoundDatatype.java b/src/java/org/apache/fop/datatypes/CompoundDatatype.java index c4a198d93..6f88e82a7 100644 --- a/src/java/org/apache/fop/datatypes/CompoundDatatype.java +++ b/src/java/org/apache/fop/datatypes/CompoundDatatype.java @@ -28,7 +28,7 @@ public interface CompoundDatatype extends Constants { /** * Sets a component of the compound datatype. - * @param Constants ID of the component + * @param cmpId ID of the component * @param cmpnValue value of the component * @param bIsDefault Indicates if it's the default value */ @@ -36,7 +36,7 @@ public interface CompoundDatatype extends Constants { /** * Returns a component of the compound datatype. - * @param Constants ID of the component + * @param cmpId ID of the component * @return the value of the component */ Property getComponent(int cmpId); diff --git a/src/java/org/apache/fop/fo/FOEventHandler.java b/src/java/org/apache/fop/fo/FOEventHandler.java index 8d38503c4..3dce3be46 100644 --- a/src/java/org/apache/fop/fo/FOEventHandler.java +++ b/src/java/org/apache/fop/fo/FOEventHandler.java @@ -84,7 +84,7 @@ public abstract class FOEventHandler { /** * Main constructor - * @param FOUserAgent the apps.FOUserAgent instance for this process + * @param foUserAgent the apps.FOUserAgent instance for this process */ public FOEventHandler(FOUserAgent foUserAgent) { this.foUserAgent = foUserAgent; @@ -203,7 +203,7 @@ public abstract class FOEventHandler { /** * - * @param bl BlockContainer that is starting. + * @param blc BlockContainer that is starting. */ public void startBlockContainer(BlockContainer blc) { } diff --git a/src/java/org/apache/fop/fo/FONode.java b/src/java/org/apache/fop/fo/FONode.java index 0347b73d5..0e00b7006 100644 --- a/src/java/org/apache/fop/fo/FONode.java +++ b/src/java/org/apache/fop/fo/FONode.java @@ -355,10 +355,9 @@ public abstract class FONode implements Cloneable { } /** - * Helper function to return missing child element errors - * (e.g., fo:layout-master-set not having any page-master child element) - * @param contentModel The XSL Content Model for the fo: object. - * or a similar description indicating child elements needed. + * Helper function to throw an error caused by missing mandatory child elements. + * E.g., fo:layout-master-set not having any page-master child element. + * @param contentModel The XSL Content Model for the fo: object or a similar description indicating the necessary child elements. */ protected void missingChildElementError(String contentModel) throws ValidationException { @@ -368,10 +367,8 @@ public abstract class FONode implements Cloneable { } /** - * Helper function to return missing child element errors - * (e.g., fo:layout-master-set not having any page-master child element) - * @param contentModel The XSL Content Model for the fo: object. - * or a similar description indicating child elements needed. + * Helper function to throw an error caused by missing mandatory properties + * @param propertyName the name of the missing property. */ protected void missingPropertyError(String propertyName) throws ValidationException { diff --git a/src/java/org/apache/fop/fo/expr/NumericOp.java b/src/java/org/apache/fop/fo/expr/NumericOp.java index 026f3a09e..34aa29d00 100755 --- a/src/java/org/apache/fop/fo/expr/NumericOp.java +++ b/src/java/org/apache/fop/fo/expr/NumericOp.java @@ -140,10 +140,9 @@ public class NumericOp { } /** - * Return the absolute value of the operand Numeric. - * @param op1 The first operand. - * @param op2 The second operand. - * @return A new Numeric object representing the absolute value. + * Return the absolute value of a Numeric. + * @param op the operand. + * @return a new Numeric object representing the absolute value of the operand. */ public static Numeric abs(Numeric op) throws PropertyException { if (op.isAbsolute()) { @@ -158,10 +157,9 @@ public class NumericOp { } /** - * Return the absolute value of the operand Numeric. - * @param op1 The first operand. - * @param op2 The second operand. - * @return A new Numeric object representing the absolute value. + * Return the negation of a Numeric. + * @param op the operand. + * @return a new Numeric object representing the negation of the operand. */ public static Numeric negate(Numeric op) throws PropertyException { if (op.isAbsolute()) { @@ -176,12 +174,11 @@ public class NumericOp { } /** - * Return the largest of the two operands. + * Return the larger of the two Numerics. * @param op1 The first operand. * @param op2 The second operand. * @return a Numeric which is the maximum of the two operands. - * @throws PropertyException If the dimensions or value types of the - * object and the operand are different. + * @throws PropertyException if the dimensions or value types of the operands are different. */ public static Numeric max(Numeric op1, Numeric op2) throws PropertyException { if (op1.isAbsolute() && op2.isAbsolute()) { @@ -199,12 +196,11 @@ public class NumericOp { } /** - * Return the smallest of the two operands. + * Return the smaller of two Numerics. * @param op1 The first operand. * @param op2 The second operand. * @return a Numeric which is the minimum of the two operands. - * @throws PropertyException If the dimensions or value types of the - * object and the operand are different. + * @throws PropertyException if the dimensions or value types of the operands are different. */ public static Numeric min(Numeric op1, Numeric op2) throws PropertyException { if (op1.isAbsolute() && op2.isAbsolute()) { diff --git a/src/java/org/apache/fop/fo/expr/NumericProperty.java b/src/java/org/apache/fop/fo/expr/NumericProperty.java index ddaac5088..72de27750 100644 --- a/src/java/org/apache/fop/fo/expr/NumericProperty.java +++ b/src/java/org/apache/fop/fo/expr/NumericProperty.java @@ -34,7 +34,6 @@ public class NumericProperty extends Property implements Numeric, Length { /** * Construct a Numeric object by specifying one or more components, * including absolute length, percent length, table units. - * @param valType A combination of bits representing the value types. * @param value The value of the numeric. * @param dim The dimension of the value. 0 for a Number, 1 for a Length * (any type), >1, <0 if Lengths have been multiplied or divided. diff --git a/src/java/org/apache/fop/fo/flow/ExternalGraphic.java b/src/java/org/apache/fop/fo/flow/ExternalGraphic.java index 4bb99c5e9..eeaa5080a 100644 --- a/src/java/org/apache/fop/fo/flow/ExternalGraphic.java +++ b/src/java/org/apache/fop/fo/flow/ExternalGraphic.java @@ -280,7 +280,7 @@ public class ExternalGraphic extends FObj { } /** - * @see org.apache.fop.fo.FObj#getLayoutDimension(org.apache.fop.datatypes.PercentBase.DimensionType) + * @see org.apache.fop.fo.FObj#getLayoutDimension(org.apache.fop.datatypes.PercentBase.LayoutDimension) */ public Number getLayoutDimension(PercentBase.LayoutDimension key) { if (key == PercentBase.IMAGE_INTRINSIC_WIDTH) { diff --git a/src/java/org/apache/fop/fo/flow/InstreamForeignObject.java b/src/java/org/apache/fop/fo/flow/InstreamForeignObject.java index 563de2f14..5c67135ef 100644 --- a/src/java/org/apache/fop/fo/flow/InstreamForeignObject.java +++ b/src/java/org/apache/fop/fo/flow/InstreamForeignObject.java @@ -121,7 +121,7 @@ public class InstreamForeignObject extends FObj { } /** - * @see org.apache.fop.fo.FONode#start + * @see org.apache.fop.fo.FONode#startOfNode */ protected void startOfNode() throws FOPException { checkId(id); diff --git a/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java b/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java index 078c88533..ee7bcce1c 100644 --- a/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java +++ b/src/java/org/apache/fop/fo/pagination/SimplePageMaster.java @@ -69,7 +69,7 @@ public class SimplePageMaster extends FObj { } /** - * @see org.apache.fop.fo.FObj#resolve + * @see org.apache.fop.fo.FObj#bind */ public void bind(PropertyList pList) throws FOPException { commonMarginBlock = pList.getMarginBlockProps(); diff --git a/src/java/org/apache/fop/layoutmgr/BlockContainerLayoutManager.java b/src/java/org/apache/fop/layoutmgr/BlockContainerLayoutManager.java index 1fad79154..16a94d4bc 100644 --- a/src/java/org/apache/fop/layoutmgr/BlockContainerLayoutManager.java +++ b/src/java/org/apache/fop/layoutmgr/BlockContainerLayoutManager.java @@ -849,7 +849,7 @@ public class BlockContainerLayoutManager extends BlockStackingLayoutManager { /** * Force current area to be added to parent area. - * @see org.apache.fop.layoutmgr.AbstractLayoutManager#flush() + * @see org.apache.fop.layoutmgr.BlockStackingLayoutManager#flush() */ protected void flush() { viewportBlockArea.addBlock(referenceArea, autoHeight); diff --git a/src/java/org/apache/fop/layoutmgr/BreakingAlgorithm.java b/src/java/org/apache/fop/layoutmgr/BreakingAlgorithm.java index f71a9fd7d..74a5ef1e2 100644 --- a/src/java/org/apache/fop/layoutmgr/BreakingAlgorithm.java +++ b/src/java/org/apache/fop/layoutmgr/BreakingAlgorithm.java @@ -730,17 +730,17 @@ public abstract class BreakingAlgorithm { /** * Return the element at index idx in the paragraph. * @param idx index of the element. - * @return + * @return the element at index idx in the paragraph. */ protected KnuthElement getElement(int idx) { return (KnuthElement) par.get(idx); } /** - * Compare two KnuthNodes and return the node with the least demerit. + * Compare two KnuthNodes and return the node with the least demerit. * @param node1 The first knuth node. * @param node2 The other knuth node. - * @return + * @return the node with the least demerit. */ protected KnuthNode compareNodes(KnuthNode node1, KnuthNode node2) { if (node1 == null || node2.position > node1.position) { diff --git a/src/java/org/apache/fop/render/java2d/Java2DRenderer.java b/src/java/org/apache/fop/render/java2d/Java2DRenderer.java index b3ae1a47a..b4a8fdbf2 100644 --- a/src/java/org/apache/fop/render/java2d/Java2DRenderer.java +++ b/src/java/org/apache/fop/render/java2d/Java2DRenderer.java @@ -723,7 +723,7 @@ public abstract class Java2DRenderer extends AbstractRenderer implements Printab } /** - * @see org.apache.fop.render.Renderer#renderText(TextArea) + * @see org.apache.fop.render.AbstractRenderer#renderText(TextArea) */ public void renderText(TextArea text) { @@ -752,7 +752,7 @@ public abstract class Java2DRenderer extends AbstractRenderer implements Printab } /** - * @see org.apache.fop.render.Renderer#renderCharacter(Character) + * @see org.apache.fop.render.AbstractRenderer#renderCharacter(Character) */ public void renderCharacter(Character ch) { diff --git a/src/java/org/apache/fop/render/java2d/RendererState.java b/src/java/org/apache/fop/render/java2d/RendererState.java index f89c8c531..3253294f5 100644 --- a/src/java/org/apache/fop/render/java2d/RendererState.java +++ b/src/java/org/apache/fop/render/java2d/RendererState.java @@ -120,7 +120,7 @@ public interface RendererState { /** * Overwrites the Transform in the Graphics2D context. Use <code>transform()</code> if you * wish to compose with the current Affinetransform instead. - * @see java.awt.Graphics2D.setTransform(). + * @see java.awt.Graphics2D#setTransform(AffineTransform tf). * @param tf the transform to concatonate to the current level transform */ public abstract void setTransform(AffineTransform tf); @@ -128,7 +128,7 @@ public interface RendererState { /** * Composes an AffineTransform object with the Transform in this Graphics2D * according to the rule last-specified-first-applied. - * @see java.awt.Graphics2D.transform(). + * @see java.awt.Graphics2D#transform(AffineTransform tf). * * @param tf the transform to concatonate to the current level transform */ diff --git a/src/java/org/apache/fop/render/pdf/PDFRenderer.java b/src/java/org/apache/fop/render/pdf/PDFRenderer.java index aeb04e11c..9d343314b 100644 --- a/src/java/org/apache/fop/render/pdf/PDFRenderer.java +++ b/src/java/org/apache/fop/render/pdf/PDFRenderer.java @@ -1315,7 +1315,7 @@ public class PDFRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.Renderer#renderCharacter(Character) + * @see org.apache.fop.render.AbstractRenderer#renderCharacter(Character) */ public void renderCharacter(Character ch) { StringBuffer pdf = new StringBuffer(); @@ -1388,7 +1388,7 @@ public class PDFRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.Renderer#renderText(TextArea) + * @see org.apache.fop.render.AbstractRenderer#renderText(TextArea) */ public void renderText(TextArea text) { beginTextObject(); diff --git a/src/java/org/apache/fop/render/ps/PSRenderer.java b/src/java/org/apache/fop/render/ps/PSRenderer.java index 4b549cf0c..1a360990c 100644 --- a/src/java/org/apache/fop/render/ps/PSRenderer.java +++ b/src/java/org/apache/fop/render/ps/PSRenderer.java @@ -441,7 +441,7 @@ public class PSRenderer extends PrintRenderer { } /** - * @see org.apache.fop.render.Renderer#renderText(TextArea) + * @see org.apache.fop.render.AbstractRenderer#renderText(TextArea) */ public void renderText(TextArea area) { String fontname = (String)area.getTrait(Trait.FONT_NAME); diff --git a/src/java/org/apache/fop/render/svg/SVGRenderer.java b/src/java/org/apache/fop/render/svg/SVGRenderer.java index 7e124e0b6..eb525e5f2 100644 --- a/src/java/org/apache/fop/render/svg/SVGRenderer.java +++ b/src/java/org/apache/fop/render/svg/SVGRenderer.java @@ -202,7 +202,7 @@ public class SVGRenderer extends AbstractRenderer implements XMLHandler { } /** - * @see org.apache.fop.render.Renderer#startPageSequence(Title) + * @see org.apache.fop.render.Renderer#startPageSequence(LineArea) */ public void startPageSequence(LineArea seqTitle) { totalWidth += sequenceWidth; @@ -351,7 +351,7 @@ public class SVGRenderer extends AbstractRenderer implements XMLHandler { } /** - * @see org.apache.fop.render.Renderer#renderLeader(Leader) + * @see org.apache.fop.render.AbstractRenderer#renderLeader(Leader) */ public void renderLeader(Leader area) { String style = "stroke:black;stroke-width:" @@ -386,7 +386,7 @@ public class SVGRenderer extends AbstractRenderer implements XMLHandler { } /** - * @see org.apache.fop.render.Renderer#renderText(TextArea) + * @see org.apache.fop.render.AbstractRenderer#renderText(TextArea) */ public void renderText(TextArea text) { Element textElement = SVGUtilities.createText(svgDocument, @@ -399,7 +399,7 @@ public class SVGRenderer extends AbstractRenderer implements XMLHandler { } /** - * @see org.apache.fop.render.Renderer#renderCharacter(Character) + * @see org.apache.fop.render.AbstractRenderer#renderCharacter(Character) */ public void renderCharacter(org.apache.fop.area.inline.Character ch) { Element text = SVGUtilities.createText(svgDocument, diff --git a/src/java/org/apache/fop/render/xml/XMLRenderer.java b/src/java/org/apache/fop/render/xml/XMLRenderer.java index 30f95a8f4..48b1b6ec7 100644 --- a/src/java/org/apache/fop/render/xml/XMLRenderer.java +++ b/src/java/org/apache/fop/render/xml/XMLRenderer.java @@ -346,7 +346,7 @@ public class XMLRenderer extends AbstractRenderer { } /** - * @see org.apache.fop.render.Renderer#startPageSequence(Title) + * @see org.apache.fop.render.Renderer#startPageSequence(LineArea) */ public void startPageSequence(LineArea seqTitle) { if (startedSequence) { @@ -454,7 +454,7 @@ public class XMLRenderer extends AbstractRenderer { } /** - * @see org.apache.fop.render.AbstractRenderer#renderFlow(Flow) + * @see org.apache.fop.render.AbstractRenderer#renderFlow(NormalFlow) */ protected void renderFlow(NormalFlow flow) { // the normal flow reference area contains stacked blocks |