Eliminate javadocs warnings.

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

src/java/org/apache/fop/afp/AFPGraphics2D.java

@@ -67,7 +67,7 @@ import org.apache.fop.svg.NativeImageHandler;
 
 /**
  * This is a concrete implementation of {@link AbstractGraphics2D} (and
- * therefore of {@link Graphics2D}) which is able to generate GOCA byte
+ * therefore of {@link java.awt.Graphics2D}) which is able to generate GOCA byte
  * codes.
  *
  * @see org.apache.xmlgraphics.java2d.AbstractGraphics2D
@@ -165,7 +165,7 @@ public class AFPGraphics2D extends AbstractGraphics2D implements NativeImageHand
     }
 
     /**
-     * Returns the AFP resource manager associated with this {@link Graphics2D} instance.
+     * Returns the AFP resource manager associated with this {@link java.awt.Graphics2D} instance.
      * @return the resource manager
      */
     public AFPResourceManager getResourceManager() {

src/java/org/apache/fop/afp/modca/ImageObject.java

@@ -119,7 +119,8 @@ public class ImageObject extends AbstractDataObject {
      * Sets the image IDE color model.
      *
      * @param colorModel    the IDE color model.
-     * @deprecated Use {@link IDEStructureParameter#setColorModel(byte)} instead.
+     * @deprecated Use {@link org.apache.fop.afp.ioca.IDEStructureParameter#setColorModel(byte)}
+     * instead.
      */
     public void setIDEColorModel(byte colorModel) {
         getImageSegment().setIDEColorModel(colorModel);
@@ -128,7 +129,8 @@ public class ImageObject extends AbstractDataObject {
     /**
      * Set either additive or subtractive mode (used for ASFLAG).
      * @param subtractive true for subtractive mode, false for additive mode
-     * @deprecated Use {@link IDEStructureParameter#setSubtractive(boolean)} instead.
+     * @deprecated Use {@link org.apache.fop.afp.ioca.IDEStructureParameter#setSubtractive(boolean)}
+     * instead.
      */
     public void setSubtractive(boolean subtractive) {
         getImageSegment().setSubtractive(subtractive);

src/java/org/apache/fop/afp/modca/PresentationTextData.java

@@ -46,7 +46,7 @@ import org.apache.fop.afp.util.BinaryUtils;
  * which signal an alternate mode of processing for the content of the current
  * Presentation Text data.
  * <p>
- * The content for this object can be created using {@link PtocaBuilder}.
+ * The content for this object can be created using {@link org.apache.fop.afp.ptoca.PtocaBuilder}.
  */
 public class PresentationTextData extends AbstractAFPObject implements PtocaConstants {
 

src/java/org/apache/fop/afp/util/DefaultFOPResourceAccessor.java

@@ -44,7 +44,8 @@ public class DefaultFOPResourceAccessor extends SimpleResourceAccessor {
      * Constructor for resource to be accessed via the {@link FOUserAgent}. This contructor
      * can take two base URIs: the category base URI is the one to use when differentiating between
      * normal resources (ex. images) and font resources. So, if fonts need to be accessed, you can
-     * set the {@link FontManager}'s base URI instead of the one on the {@link FopFactory}.
+     * set the {@link org.apache.fop.fonts.FontManager}'s base URI instead of the one on the
+     * {@link org.apache.fop.apps.FopFactory}.
      * @param userAgent the FO user agent
      * @param categoryBaseURI the category base URI (may be null)
      * @param baseURI the custom base URI to resolve relative URIs against (may be null)

src/java/org/apache/fop/apps/FOUserAgent.java

@@ -355,7 +355,7 @@ public class FOUserAgent {
     /**
      * Sets font base URL.
      * @param fontBaseUrl font base URL
-     * @deprecated Use {@link FontManager#setFontBaseURL(String)} instead.
+     * @deprecated Use {@link org.apache.fop.fonts.FontManager#setFontBaseURL(String)} instead.
      */
     public void setFontBaseURL(String fontBaseUrl) {
         try {
@@ -500,7 +500,8 @@ public class FOUserAgent {
     /**
      * Returns the font base URL.
      * @return the font base URL
-     * @deprecated Use {@link FontManager#getFontBaseURL()} instead. This method is not used by FOP.
+     * @deprecated Use {@link org.apache.fop.fonts.FontManager#getFontBaseURL()} instead.
+     * This method is not used by FOP.
      */
     public String getFontBaseURL() {
         String fontBase = getFactory().getFontManager().getFontBaseURL();

src/java/org/apache/fop/complexscripts/fonts/GlyphPositioningTable.java

@@ -1783,9 +1783,9 @@ public class GlyphPositioningTable extends GlyphTable {
          * Find device adjustment.
          * @param fontSize the font size to search for
          * @return an adjustment if font size matches an entry
-         * @asf.todo at present, assumes that 1 device unit equals one point
          */
         public int findAdjustment ( int fontSize ) {
+            // [TODO] at present, assumes that 1 device unit equals one point
             int fs = fontSize / 1000;
             if ( fs < startSize ) {
                 return 0;

src/java/org/apache/fop/complexscripts/scripts/IndicScriptProcessor.java

@@ -360,7 +360,7 @@ public class IndicScriptProcessor extends DefaultScriptProcessor {
     }
 
     /** Abstract syllabizer. */
-    protected abstract static class Syllabizer {
+    protected abstract static class Syllabizer implements Comparable {
         private String script;
         private String language;
         Syllabizer ( String script, String language ) {

src/java/org/apache/fop/fo/FOEventHandler.java

@@ -123,11 +123,17 @@ public abstract class FOEventHandler {
     public void endDocument() throws SAXException {
     }
 
-    /** {@inheritDoc} */
+    /**
+     * Called upon start of root element.
+     * @param root element
+     */
     public void startRoot(Root root) {
     }
 
-    /** {@inheritDoc} */
+    /**
+     * Called upon end of root element.
+     * @param root element
+     */
     public void endRoot(Root root) {
     }
 
@@ -413,9 +419,9 @@ public abstract class FOEventHandler {
 
     /**
      * Process end of a Static.
-     * @param statisContent StaticContent that is ending
+     * @param staticContent StaticContent that is ending
      */
-    public void endStatic(StaticContent statisContent) {
+    public void endStatic(StaticContent staticContent) {
     }
 
 

src/java/org/apache/fop/layoutmgr/BalancingColumnBreakingAlgorithm.java

@@ -41,12 +41,16 @@ public class BalancingColumnBreakingAlgorithm extends PageBreakingAlgorithm {
      * @param topLevelLM the top level layout manager
      * @param pageProvider the page provider
      * @param layoutListener the layout listener
-     * @param alignment     alignment of the paragraph/page. One of {@link Constants#EN_START},
-     *                  {@link Constants#EN_JUSTIFY}, {@link Constants#EN_CENTER},
-     *                  {@link Constants#EN_END}.
-     *                  For pages, {@link Constants#EN_BEFORE} and {@link Constants#EN_AFTER}
-     *                  are mapped to the corresponding inline properties,
-     *                  {@link Constants#EN_START} and {@link Constants#EN_END}.
+     * @param alignment     alignment of the paragraph/page. One of
+     *   {@link org.apache.fop.fo.Constants#EN_START},
+     *   {@link org.apache.fop.fo.Constants#EN_JUSTIFY},
+     *   {@link org.apache.fop.fo.Constants#EN_CENTER},
+     *   {@link org.apache.fop.fo.Constants#EN_END}.
+     *   For pages, {@link org.apache.fop.fo.Constants#EN_BEFORE} and
+     *   {@link org.apache.fop.fo.Constants#EN_AFTER}
+     *   are mapped to the corresponding inline properties,
+     *   {@link org.apache.fop.fo.Constants#EN_START} and
+     *   {@link org.apache.fop.fo.Constants#EN_END}.
      * @param alignmentLast alignment of the paragraph's last line
      * @param footnoteSeparatorLength length of footnote separator
      * @param partOverflowRecovery  {@code true} if too long elements should be moved to

src/java/org/apache/fop/layoutmgr/BreakElement.java

@@ -46,8 +46,11 @@ public class BreakElement extends UnresolvedListElement {
      * Create a new BreakElement for the given {@code position}, {@code penaltyValue}
      * and {@code breakClass}. (Used principally to generate break-possibilities in
      * ranges of content that must be kept together within the context corresponding
-     * to the {@code breakClass}; expected to be one of {@link Constants#EN_AUTO},
-     * {@link Constants#EN_LINE}, {@link Constants#EN_COLUMN} or {@link Constants#EN_PAGE})
+     * to the {@code breakClass}; expected to be one of
+     *   {@link org.apache.fop.fo.Constants#EN_AUTO},
+     *   {@link org.apache.fop.fo.Constants#EN_LINE},
+     *   {@link org.apache.fop.fo.Constants#EN_COLUMN} or
+     *   {@link org.apache.fop.fo.Constants#EN_PAGE})
      * @param position  the corresponding {@link Position}
      * @param penaltyValue  the penalty value
      * @param breakClass    the break class
@@ -64,9 +67,12 @@ public class BreakElement extends UnresolvedListElement {
      * @param position the Position instance needed by the addAreas stage of the LMs.
      * @param penaltyWidth the penalty width
      * @param penaltyValue the penalty value for the penalty element to be constructed
-     * @param breakClass the break class of this penalty (one of {@link Constants#EN_AUTO},
-     * {@link Constants#EN_COLUMN}, {@link Constants#EN_PAGE},
-     * {@link Constants#EN_EVEN_PAGE}, {@link Constants#EN_ODD_PAGE})
+     * @param breakClass the break class of this penalty (one of
+     *   {@link org.apache.fop.fo.Constants#EN_AUTO},
+     *   {@link org.apache.fop.fo.Constants#EN_COLUMN},
+     *   {@link org.apache.fop.fo.Constants#EN_PAGE},
+     *   {@link org.apache.fop.fo.Constants#EN_EVEN_PAGE},
+     *   {@link org.apache.fop.fo.Constants#EN_ODD_PAGE})
      * @param context the layout context which contains the pending conditional elements
      */
     public BreakElement(Position position, int penaltyWidth, int penaltyValue,
@@ -120,9 +126,12 @@ public class BreakElement extends UnresolvedListElement {
     /**
      * Returns the break class of this penalty.
      *
-     * @return one of {@link Constants#EN_AUTO}, {@link Constants#EN_COLUMN},
-     * {@link Constants#EN_PAGE}, {@link Constants#EN_EVEN_PAGE},
-     * {@link Constants#EN_ODD_PAGE}
+     * @return one of
+     *   {@link org.apache.fop.fo.Constants#EN_AUTO},
+     *   {@link org.apache.fop.fo.Constants#EN_COLUMN},
+     *   {@link org.apache.fop.fo.Constants#EN_PAGE},
+     *   {@link org.apache.fop.fo.Constants#EN_EVEN_PAGE},
+     *   {@link org.apache.fop.fo.Constants#EN_ODD_PAGE}.
      */
     public int getBreakClass() {
         return breakClass;
@@ -131,9 +140,12 @@ public class BreakElement extends UnresolvedListElement {
     /**
      * Sets the break class.
      *
-     * @param breakClass one of {@link Constants#EN_AUTO}, {@link Constants#EN_COLUMN},
-     * {@link Constants#EN_PAGE}, {@link Constants#EN_EVEN_PAGE},
-     * {@link Constants#EN_ODD_PAGE}
+     * @param breakClass one of
+     *   {@link org.apache.fop.fo.Constants#EN_AUTO},
+     *   {@link org.apache.fop.fo.Constants#EN_COLUMN},
+     *   {@link org.apache.fop.fo.Constants#EN_PAGE},
+     *   {@link org.apache.fop.fo.Constants#EN_EVEN_PAGE},
+     *   {@link org.apache.fop.fo.Constants#EN_ODD_PAGE}.
      */
     public void setBreakClass(int breakClass) {
         this.breakClass = breakClass;

src/java/org/apache/fop/layoutmgr/KnuthPenalty.java

@@ -72,8 +72,11 @@ public class KnuthPenalty extends KnuthElement {
      * @param penalty the penalty value of this penalty
      * @param penaltyFlagged is this penalty flagged?
      * @param breakClass the break class of this penalty (one of
-     * {@link Constants#EN_AUTO}, {@link Constants#EN_COLUMN}, {@link Constants#EN_PAGE},
-     * {@link Constants#EN_EVEN_PAGE}, {@link Constants#EN_ODD_PAGE})
+     *   {@link org.apache.fop.fo.Constants#EN_AUTO},
+     *   {@link org.apache.fop.fo.Constants#EN_COLUMN},
+     *   {@link org.apache.fop.fo.Constants#EN_PAGE},
+     *   {@link org.apache.fop.fo.Constants#EN_EVEN_PAGE},
+     *   {@link org.apache.fop.fo.Constants#EN_ODD_PAGE}).
      * @param pos the Position stored in this penalty
      * @param isAuxiliary is this penalty auxiliary?
      */

src/java/org/apache/fop/pdf/PDFColor.java

@@ -30,7 +30,7 @@ import org.apache.xmlgraphics.java2d.color.DeviceCMYKColorSpace;
  * image. And in this context, only RGB and Gray values are used.
  * <p>
  * Use of this class is discouraged. {@link PDFColorHandler} is now used for in-content color
- * selection. For masked bitmaps, it may be wiser to switch to {@link Color} in the long run.
+ * selection. For masked bitmaps, it may be wiser to switch to {@link java.awt.Color} in the long run.
  */
 public class PDFColor extends PDFPathPaint {
     // could be 3.0 as well.

src/java/org/apache/fop/pdf/PDFEmbeddedFile.java

@@ -38,7 +38,10 @@ public class PDFEmbeddedFile extends PDFStream {
         put("Params", params);
     }
 
-    /** {@inheritDoc} */
+    /**
+     * Determine if should encode on the fly.
+     * @return true if should encode on the fly
+     */
     protected boolean isEncodingOnTheFly() {
         //Acrobat doesn't like an indirect /Length object in this case,
         //but only when the embedded file is a PDF file.

src/java/org/apache/fop/pdf/PDFObject.java

@@ -22,7 +22,6 @@ package org.apache.fop.pdf;
 // Java
 import java.io.IOException;
 import java.io.OutputStream;
-import java.io.Writer;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
@@ -210,11 +209,6 @@ public abstract class PDFObject implements PDFWritable {
         return pdf.length;
     }
 
-    /** {@inheritDoc} */
-    public void outputInline(OutputStream out, Writer writer) throws IOException {
-        throw new UnsupportedOperationException("Don't use anymore: " + getClass().getName());
-    }
-
     /** {@inheritDoc} */
     public void outputInline(OutputStream out, StringBuilder textBuffer) throws IOException {
         if (hasObjectNumber()) {

src/java/org/apache/fop/render/ImageHandler.java

@@ -33,7 +33,8 @@ public interface ImageHandler extends ImageHandlerBase {
      * Indicates whether the image handler is compatible with the indicated target represented
      * by the rendering context object and with the image to be processed. The image is also
      * passed as a parameter because a handler might not support every subtype of image that is
-     * presented. For example: in the case of {@link ImageXMLDOM}, the image might carry an SVG
+     * presented. For example: in the case of
+     * {@link org.apache.xmlgraphics.image.loader.impl.ImageXMLDOM}, the image might carry an SVG
      * or some other XML format. One handler might only handle SVG but no other XML format.
      * @param targetContext the target rendering context
      * @param image the image to be processed (or null if only to check based on the rendering

src/java/org/apache/fop/render/afp/AFPDocumentHandler.java

@@ -58,7 +58,8 @@ import org.apache.fop.render.intermediate.IFException;
 import org.apache.fop.render.intermediate.IFPainter;
 
 /**
- * {@link IFDocumentHandler} implementation that produces AFP (MO:DCA).
+ * {@link org.apache.fop.render.intermediate.IFDocumentHandler} implementation that
+ * produces AFP (MO:DCA).
  */
 public class AFPDocumentHandler extends AbstractBinaryWritingIFDocumentHandler
             implements AFPCustomizable {

src/java/org/apache/fop/render/afp/extensions/AFPIncludeFormMap.java

@@ -27,7 +27,7 @@ import org.xml.sax.helpers.AttributesImpl;
 
 /**
  * This extension allows to include an AFP form map resource. It is implemented as an extension
- * attachment ({@link ExtensionAttachment}).
+ * attachment ({@link org.apache.fop.fo.extensions.ExtensionAttachment}).
  */
 public class AFPIncludeFormMap extends AFPExtensionAttachment {
 

src/java/org/apache/fop/render/afp/extensions/AFPIncludeFormMapElement.java

@@ -32,8 +32,8 @@ import org.apache.fop.fo.PropertyList;
 import org.apache.fop.fo.extensions.ExtensionAttachment;
 
 /**
- * This class extends the {@link ExtensionObj} class. It represents the "include-form-map"
- * extension in the FO tree.
+ * This class extends the {@link org.apache.fop.fo.extensions.ExtensionObj} class.
+ * It represents the "include-form-map" extension in the FO tree.
  */
 public class AFPIncludeFormMapElement extends AbstractAFPExtensionObject {
 

src/java/org/apache/fop/render/afp/extensions/AFPPageOverlay.java

@@ -25,7 +25,7 @@ import org.xml.sax.helpers.AttributesImpl;
 
 /**
  * This extension allows to include an AFP Page Overlay resource. It is implemented as an extension
- * attachment ({@link ExtensionAttachment}).
+ * attachment ({@link org.apache.fop.fo.extensions.ExtensionAttachment}).
  */
 public class AFPPageOverlay extends AFPExtensionAttachment {
 

src/java/org/apache/fop/render/bitmap/AbstractBitmapDocumentHandler.java

@@ -47,7 +47,8 @@ import org.apache.fop.render.java2d.Java2DPainter;
 import org.apache.fop.render.java2d.Java2DUtil;
 
 /**
- * Abstract {@link IFDocumentHandler} implementation for producing bitmap images.
+ * Abstract {@link org.apache.fop.render.intermediate.IFDocumentHandler} implementation
+ * for producing bitmap images.
  */
 public abstract class AbstractBitmapDocumentHandler extends AbstractBinaryWritingIFDocumentHandler {
 

src/java/org/apache/fop/render/bitmap/PNGDocumentHandler.java

@@ -23,7 +23,8 @@ import org.apache.fop.apps.MimeConstants;
 import org.apache.fop.render.intermediate.IFDocumentHandlerConfigurator;
 
 /**
- * {@link IFDocumentHandler} implementation that produces PNG files.
+ * {@link org.apache.fop.render.intermediate.IFDocumentHandler} implementation
+ * that produces PNG files.
  */
 public class PNGDocumentHandler extends AbstractBitmapDocumentHandler {
 

src/java/org/apache/fop/render/bitmap/TIFFDocumentHandler.java

@@ -23,7 +23,8 @@ import org.apache.fop.apps.MimeConstants;
 import org.apache.fop.render.intermediate.IFDocumentHandlerConfigurator;
 
 /**
- * {@link IFDocumentHandler} implementation that produces TIFF files.
+ * {@link org.apache.fop.render.intermediate.IFDocumentHandler} implementation
+ * that produces TIFF files.
  */
 public class TIFFDocumentHandler extends AbstractBitmapDocumentHandler {
 

src/java/org/apache/fop/render/intermediate/IFContext.java

@@ -145,7 +145,7 @@ public class IFContext {
 
     /**
      * Resets the current structure tree element.
-     * @see #setStructureTreeElement(String)
+     * @see #setStructureTreeElement(StructureTreeElement)
      */
     public void resetStructureTreeElement() {
         setStructureTreeElement(null);
@@ -154,7 +154,7 @@ public class IFContext {
     /**
      * Returns the current structure tree element.
      * @return the structure tree element (or null if no element is active)
-     * @see #setStructureTreeElement(String)
+     * @see #setStructureTreeElement(StructureTreeElement)
      */
     public StructureTreeElement getStructureTreeElement() {
         return this.structureTreeElement;

src/java/org/apache/fop/render/intermediate/IFUtil.java

@@ -147,8 +147,8 @@ public final class IFUtil {
 
     /**
      * Sets up the fonts on a document handler. If the document handler provides a configurator
-     * object the configuration from the {@link FopFactory} will be used. Otherwise,
-     * a default font configuration will be set up.
+     * object the configuration from the {@link org.apache.fop.apps.FopFactory} will be used.
+     * Otherwise, a default font configuration will be set up.
      * @param documentHandler the document handler
      * @param fontInfo the font info object (may be null)
      * @throws FOPException if an error occurs while setting up the fonts
@@ -175,8 +175,8 @@ public final class IFUtil {
 
     /**
      * Sets up the fonts on a document handler. If the document handler provides a configurator
-     * object the configuration from the {@link FopFactory} will be used. Otherwise,
-     * a default font configuration will be set up.
+     * object the configuration from the {@link org.apache.fop.apps.FopFactory} will be used.
+     * Otherwise, a default font configuration will be set up.
      * @param documentHandler the document handler
      * @throws FOPException if an error occurs while setting up the fonts
      */

src/java/org/apache/fop/render/java2d/CustomFontMetricsMapper.java

@@ -36,7 +36,7 @@ import org.apache.fop.fonts.Typeface;
 
 /**
  * FontMetricsMapper that delegates most methods to an underlying
- * {@link FontMetrics} instance. This class was designed to allow
+ * {@link org.apache.fop.fonts.FontMetrics} instance. This class was designed to allow
  * the underlying {@link Font} to be loaded from a
  * user-configured file not registered in the current graphics environment.
  */

src/java/org/apache/fop/render/java2d/Java2DPainter.java

@@ -47,7 +47,8 @@ import org.apache.fop.traits.RuleStyle;
 import org.apache.fop.util.CharUtilities;
 
 /**
- * {@link IFPainter} implementation that paints on a Graphics2D instance.
+ * {@link org.apache.fop.render.intermediate.IFPainter} implementation
+ * that paints on a Graphics2D instance.
  */
 public class Java2DPainter extends AbstractIFPainter {
 

src/java/org/apache/fop/render/pcl/PCLDocumentHandler.java

@@ -45,7 +45,8 @@ import org.apache.fop.render.java2d.Java2DUtil;
 import org.apache.fop.render.pcl.extensions.PCLElementMapping;
 
 /**
- * {@link IFDocumentHandler} implementation that produces PCL 5.
+ * {@link org.apache.fop.render.intermediate.IFDocumentHandler} implementation
+ * that produces PCL 5.
  */
 public class PCLDocumentHandler extends AbstractBinaryWritingIFDocumentHandler
             implements PCLConstants {

src/java/org/apache/fop/render/pcl/PCLPainter.java

@@ -58,7 +58,8 @@ import org.apache.fop.traits.RuleStyle;
 import org.apache.fop.util.CharUtilities;
 
 /**
- * {@link IFPainter} implementation that produces PCL 5.
+ * {@link org.apache.fop.render.intermediate.IFPainter} implementation
+ * that produces PCL 5.
  */
 public class PCLPainter extends AbstractIFPainter implements PCLConstants {
 

src/java/org/apache/fop/render/ps/NativeTextHandler.java

@@ -100,12 +100,6 @@ public class NativeTextHandler implements PSTextHandler {
         //nop
     }
 
-    /** {@inheritDoc} */
-    public void drawString(String text, float x, float y) throws IOException {
-        // TODO Remove me after removing the deprecated method in TextHandler.
-        throw new UnsupportedOperationException("Deprecated method!");
-    }
-
     /**
      * Draw a string to the PostScript document. The text is painted using
      * text operations.

src/java/org/apache/fop/render/ps/PSDocumentHandler.java

@@ -63,7 +63,8 @@ import org.apache.fop.render.ps.extensions.PSSetPageDevice;
 import org.apache.fop.render.ps.extensions.PSSetupCode;
 
 /**
- * {@link IFDocumentHandler} implementation that produces PostScript.
+ * {@link org.apache.fop.render.intermediate.IFDocumentHandler} implementation
+ * that produces PostScript.
  */
 public class PSDocumentHandler extends AbstractBinaryWritingIFDocumentHandler {
 

src/java/org/apache/fop/svg/PDFAElementBridge.java

@@ -64,7 +64,7 @@ public class PDFAElementBridge extends AbstractGraphicsNodeBridge {
     }
 
     /**
-     * Creates a {@link CompositeGraphicsNode}.
+     * Creates a {@link org.apache.batik.gvt.CompositeGraphicsNode}.
      * @return a new PDFANode
      */
     protected GraphicsNode instantiateGraphicsNode() {

src/java/org/apache/fop/traits/MinOptMax.java

@@ -22,8 +22,9 @@ package org.apache.fop.traits;
 import java.io.Serializable;
 
 /**
- * This class holds the resolved (as mpoints) form of a {@link LengthRangeProperty LengthRange} or
- * {@link SpaceProperty Space} type property value.
+ * This class holds the resolved (as mpoints) form of a
+ * {@link org.apache.fop.fo.properties.LengthRangeProperty} or
+ * {@link org.apache.fop.fo.properties.SpaceProperty} type property value.
  * <p/>
  * Instances of this class are immutable. All arithmetic methods like {@link #plus(MinOptMax) plus},
  * {@link #minus(MinOptMax) minus} or {@link #mult(int) mult} return a different instance. So it is

src/java/org/apache/fop/traits/TraitEnum.java

@@ -30,7 +30,7 @@ public abstract class TraitEnum implements Serializable {
     /**
      * Constructor to add a new named item.
      * @param name Name of the item.
-     * @param enumValue the {@link Constants}.EN_* value
+     * @param enumValue the {@link org.apache.fop.fo.Constants}.EN_* value
      */
     protected TraitEnum(String name, int enumValue) {
         this.name = name;
@@ -46,7 +46,7 @@ public abstract class TraitEnum implements Serializable {
     }
 
     /**
-     * Returns the enumeration value (one of {@link Constants}.EN_*).
+     * Returns the enumeration value (one of {@link org.apache.fop.fo.Constants}.EN_*).
      * @return the enumeration value
      */
     public int getEnumValue() {

src/java/org/apache/fop/util/ColorExt.java

@@ -28,7 +28,7 @@ import java.util.Arrays;
  * <p>
  * This class extends java.awt.Color class keeping track of the original color
  * property values specified by the fo user in a rgb-icc call.
- * @deprecated Replaced by {@link ColorWithAlternatives}
+ * @deprecated Replaced by {@link org.apache.xmlgraphics.java2d.color.ColorWithAlternatives}
  */
 @Deprecated
 public final class ColorExt extends Color {

src/sandbox/org/apache/fop/render/mif/MIFHandler.java

@@ -29,8 +29,10 @@ import org.apache.commons.logging.LogFactory;
 
 import org.apache.fop.apps.FOUserAgent;
 import org.apache.fop.fo.FOEventHandler;
+import org.apache.fop.fo.FOText;
 import org.apache.fop.fo.flow.BasicLink;
 import org.apache.fop.fo.flow.Block;
+import org.apache.fop.fo.flow.Character;
 import org.apache.fop.fo.flow.ExternalGraphic;
 import org.apache.fop.fo.flow.Footnote;
 import org.apache.fop.fo.flow.FootnoteBody;
@@ -39,6 +41,8 @@ import org.apache.fop.fo.flow.InstreamForeignObject;
 import org.apache.fop.fo.flow.Leader;
 import org.apache.fop.fo.flow.ListBlock;
 import org.apache.fop.fo.flow.ListItem;
+import org.apache.fop.fo.flow.ListItemBody;
+import org.apache.fop.fo.flow.ListItemLabel;
 import org.apache.fop.fo.flow.PageNumber;
 import org.apache.fop.fo.flow.table.Table;
 import org.apache.fop.fo.flow.table.TableBody;
@@ -51,6 +55,7 @@ import org.apache.fop.fo.pagination.Flow;
 import org.apache.fop.fo.pagination.PageSequence;
 import org.apache.fop.fo.pagination.PageSequenceMaster;
 import org.apache.fop.fo.pagination.SimplePageMaster;
+import org.apache.fop.fo.pagination.StaticContent;
 import org.apache.fop.fonts.FontSetup;
 import org.apache.fop.render.DefaultFontResolver;
 
@@ -267,27 +272,27 @@ public class MIFHandler extends FOEventHandler {
     }
 
     /** {@inheritDoc} */
-    public void startListLabel() {
+    public void startListLabel(ListItemLabel listItemLabel) {
     }
 
     /** {@inheritDoc} */
-    public void endListLabel() {
+    public void endListLabel(ListItemLabel listItemLabel) {
     }
 
     /** {@inheritDoc} */
-    public void startListBody() {
+    public void startListBody(ListItemBody listItemBody) {
     }
 
     /** {@inheritDoc} */
-    public void endListBody() {
+    public void endListBody(ListItemBody listItemBody) {
     }
 
     /** {@inheritDoc} */
-    public void startStatic() {
+    public void startStatic(StaticContent staticContent) {
     }
 
     /** {@inheritDoc} */
-    public void endStatic() {
+    public void endStatic(StaticContent staticContent) {
     }
 
     /** {@inheritDoc} */
@@ -303,7 +308,7 @@ public class MIFHandler extends FOEventHandler {
     }
 
     /** {@inheritDoc} */
-    public void endLink() {
+    public void endLink(BasicLink basicLink) {
     }
 
     /** {@inheritDoc} */
@@ -315,7 +320,11 @@ public class MIFHandler extends FOEventHandler {
     }
 
     /** {@inheritDoc} */
-    public void foreignObject(InstreamForeignObject ifo) {
+    public void startInstreamForeignObject(InstreamForeignObject ifo) {
+    }
+
+    /** {@inheritDoc} */
+    public void endInstreamForeignObject(InstreamForeignObject ifo) {
     }
 
     /** {@inheritDoc} */
@@ -335,19 +344,37 @@ public class MIFHandler extends FOEventHandler {
     }
 
     /** {@inheritDoc} */
-    public void leader(Leader l) {
+    public void startLeader(Leader l) {
+    }
+
+    /** {@inheritDoc} */
+    public void endLeader(Leader l) {
+    }
+
+    public void character(Character c) {
+        appendCharacters ( new String ( new char[] {c.getCharacter()} ) );
+    }
+
+    /** {@inheritDoc} */
+    public void characters(FOText foText) {
+        appendCharacters ( foText.getCharSequence().toString() );
+    }
+
+    /** {@inheritDoc} */
+    public void startPageNumber(PageNumber pagenum) {
     }
 
     /** {@inheritDoc} */
-    public void characters(char[] data, int start, int length) {
+    public void endPageNumber(PageNumber pagenum) {
+    }
+
+    private void appendCharacters ( String str ) {
         if (para != null) {
-            String str = new String(data, start, length);
             str = str.trim();
             // break into nice length chunks
             if (str.length() == 0) {
                 return;
             }
-
             MIFElement line = new MIFElement("ParaLine");
             MIFElement prop = new MIFElement("TextRectID");
             prop.setValue("2");
@@ -355,17 +382,8 @@ public class MIFHandler extends FOEventHandler {
             prop = new MIFElement("String");
             prop.setValue("\"" + str + "\"");
             line.addElement(prop);
-
             para.addElement(line);
         }
     }
-
-    /** {@inheritDoc} */
-    public void startPageNumber(PageNumber pagenum) {
-    }
-
-    /** {@inheritDoc} */
-    public void endPageNumber(PageNumber pagenum) {
-    }
 }
 

src/sandbox/org/apache/fop/render/svg/SVGDocumentHandler.java

@@ -54,7 +54,8 @@ import org.apache.fop.util.GenerationHelperContentHandler;
 import org.apache.fop.util.XMLUtil;
 
 /**
- * {@link IFDocumentHandler} implementation that writes SVG 1.1.
+ * {@link org.apache.fop.render.intermediate.IFDocumentHandler} implementation
+ * that writes SVG 1.1.
  */
 public class SVGDocumentHandler extends AbstractSVGDocumentHandler {
 

src/sandbox/org/apache/fop/render/svg/SVGPrintDocumentHandler.java

@@ -32,7 +32,8 @@ import org.apache.fop.render.intermediate.IFPainter;
 import org.apache.fop.util.XMLUtil;
 
 /**
- * {@link IFDocumentHandler} implementation that writes SVG Print.
+ * {@link org.apache.fop.render.intermediate.IFDocumentHandler} implementation
+ * that writes SVG Print.
  */
 public class SVGPrintDocumentHandler extends AbstractSVGDocumentHandler {
 

status.xml

@@ -63,6 +63,9 @@
       documents. Example: the fix of marks layering will be such a case when it's done.
     -->
     <release version="FOP Trunk" date="TBD">
+      <action context="Code" dev="GA" type="fix">
+        Eliminate javadocs warnings.
+      </action>
       <action context="Code" dev="GA" type="update" fixes-bug="53055">
         Update xmlgraphics common jar to reflect recent fixes in XGC.
       </action>