Fixed a few JavaDoc errors. Removed some apparently unused/obsolete methods.

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

src/java/org/apache/fop/fo/flow/Marker.java

@@ -263,7 +263,7 @@ public class Marker extends FObjMixed {
         }
 
         /**
-         * @see org.xml.sax.Attributes#getURI()
+         * @see org.xml.sax.Attributes#getURI(int)
          */
         public String getURI(int index) {
             if (attribs != null 
@@ -277,7 +277,7 @@ public class Marker extends FObjMixed {
         }
 
         /**
-         * @see org.xml.sax.Attributes#getLocalName()
+         * @see org.xml.sax.Attributes#getLocalName(int)
          */
         public String getLocalName(int index) {
             if (attribs != null 
@@ -291,7 +291,7 @@ public class Marker extends FObjMixed {
         }
 
         /**
-         * @see org.xml.sax.Attributes#getQName()
+         * @see org.xml.sax.Attributes#getQName(int)
          */
         public String getQName(int index) {
             if (attribs != null 
@@ -306,14 +306,14 @@ public class Marker extends FObjMixed {
 
         /**
          * Default implementation; not used
-         * @see org.xml.sax.Attributes#getType()
+         * @see org.xml.sax.Attributes#getType(int)
          */
         public String getType(int index) {
             return "CDATA";
         }
 
         /**
-         * @see org.xml.sax.Attributes#getValue()
+         * @see org.xml.sax.Attributes#getValue(int)
          */
         public String getValue(int index) {
             if (attribs != null 
@@ -327,7 +327,7 @@ public class Marker extends FObjMixed {
         }
 
         /**
-         * @see org.xml.sax.Attributes#getIndex()
+         * @see org.xml.sax.Attributes#getIndex(String, String)
          */
         public int getIndex(String name, String namespace) {
             int index = -1;
@@ -344,7 +344,7 @@ public class Marker extends FObjMixed {
         }
 
         /**
-         * @see org.xml.sax.Attributes#getIndex()
+         * @see org.xml.sax.Attributes#getIndex(String)
          */
         public int getIndex(String qname) {
             int index = -1;
@@ -361,7 +361,7 @@ public class Marker extends FObjMixed {
 
         /**
          * Default implementation; not used
-         * @see org.xml.sax.Attributes#getType()
+         * @see org.xml.sax.Attributes#getType(String, String)
          */
         public String getType(String name, String namespace) {
             return "CDATA";
@@ -369,14 +369,14 @@ public class Marker extends FObjMixed {
 
         /**
          * Default implementation; not used
-         * @see org.xml.sax.Attributes#getType()
+         * @see org.xml.sax.Attributes#getType(String)
          */
         public String getType(String qname) {
             return "CDATA";
         }
 
         /**
-         * @see org.xml.sax.Attributes#getValue()
+         * @see org.xml.sax.Attributes#getValue(String, String)
          */
         public String getValue(String name, String namespace) {
             int index = getIndex(name, namespace);
@@ -387,7 +387,7 @@ public class Marker extends FObjMixed {
         }
 
         /**
-         * @see org.xml.sax.Attributes#getValue()
+         * @see org.xml.sax.Attributes#getValue(String)
          */
         public String getValue(String qname) {
             int index = getIndex(qname);
@@ -397,4 +397,4 @@ public class Marker extends FObjMixed {
             return null;
         }
     }
-}
+}

src/java/org/apache/fop/fo/flow/TableBody.java

@@ -91,7 +91,7 @@ public class TableBody extends TableFObj {
     }
     
     /**
-     * @see org.apache.fop.fo.FONode#processNode()
+     * @see org.apache.fop.fo.FONode#processNode(String, Locator, Attributes, PropertyList)
      */
     public void processNode(String elementName, Locator locator, 
                             Attributes attlist, PropertyList pList) 
@@ -406,7 +406,6 @@ public class TableBody extends TableFObj {
     /**
      * Checks whether the previous cell had 'ends-row="true"'
      * 
-     * @param currentCell   the cell for which the question is asked
      * @return true if:
      *          a) there is a previous cell, which
      *             had ends-row="true"

src/java/org/apache/fop/fo/properties/BackgroundPositionShorthandParser.java

@@ -31,12 +31,12 @@ import org.apache.fop.fo.expr.PropertyException;
 public class BackgroundPositionShorthandParser extends GenericShorthandParser {
 
     /**
-     * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty()
+     * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList)
      */
     public Property getValueForProperty(int propId,
-                                               Property property,
-                                               PropertyMaker maker,
-                                               PropertyList propertyList)
+                                        Property property,
+                                        PropertyMaker maker,
+                                        PropertyList propertyList)
                     throws PropertyException {
         
         int index = -1;

src/java/org/apache/fop/fo/properties/FontShorthandParser.java

@@ -31,7 +31,7 @@ import org.apache.fop.fo.expr.PropertyException;
 public class FontShorthandParser extends GenericShorthandParser {
 
     /**
-     * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty()
+     * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList)
      */
     public Property getValueForProperty(int propId,
                                                Property property,

src/java/org/apache/fop/fo/properties/GenericShorthandParser.java

@@ -49,7 +49,7 @@ public class GenericShorthandParser implements ShorthandParser {
     }
     
     /**
-     * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty()
+     * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList)
      */
     public Property getValueForProperty(int propId,
                                         Property property,

src/java/org/apache/fop/fo/properties/LengthRangeProperty.java

@@ -94,7 +94,7 @@ public class LengthRangeProperty extends Property implements CompoundDatatype {
         
         
         /**
-         * @see org.apache.fop.fo.properties.PropertyMaker#getSubprop()
+         * @see org.apache.fop.fo.properties.PropertyMaker#getSubprop(Property, int, Property)
          */
         protected Property setSubprop(Property baseProperty, int subpropertyId,
                                         Property subproperty) {

src/java/org/apache/fop/fo/properties/PageBreakShorthandParser.java

@@ -30,7 +30,7 @@ import org.apache.fop.fo.expr.PropertyException;
 public class PageBreakShorthandParser implements ShorthandParser {
     
     /**
-     * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty()
+     * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList)
      */
     public Property getValueForProperty(int propId,
                                                Property property,

src/java/org/apache/fop/fo/properties/PositionShorthandParser.java

@@ -29,7 +29,7 @@ import org.apache.fop.fo.PropertyList;
 public class PositionShorthandParser implements ShorthandParser {
     
     /**
-     * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty()
+     * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList)
      */
     public Property getValueForProperty(int propId,
             Property property,

src/java/org/apache/fop/fo/properties/ReferenceOrientationMaker.java

@@ -31,7 +31,7 @@ public class ReferenceOrientationMaker extends Maker {
     /**
      * Constructor
      * @param propId the Constant Id for the property to be made
-     * @see org.apache.fop.fo.properties.PropertyMaker#PropertyMaker(propId)
+     * @see org.apache.fop.fo.properties.NumberProperty.Maker#PropertyMaker(propId)
      */
     public ReferenceOrientationMaker(int propId) {
         super(propId);
@@ -60,4 +60,4 @@ public class ReferenceOrientationMaker extends Maker {
         }
     }
 
-}
+}

src/java/org/apache/fop/fo/properties/WhiteSpaceShorthandParser.java

@@ -32,7 +32,7 @@ import org.apache.fop.fo.expr.PropertyException;
 public class WhiteSpaceShorthandParser implements ShorthandParser {
 
     /**
-     * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty()
+     * @see org.apache.fop.fo.properties.ShorthandParser#getValueForProperty(int, Property, PropertyMaker, PropertyList)
      */
     public Property getValueForProperty(int propId, Property property,
             PropertyMaker maker, PropertyList propertyList)

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

@@ -69,12 +69,9 @@ public class PDFMetadata extends PDFStream {
         super.setupFilterList();
     }
 
-    /** @see org.apache.fop.pdf.AbstractPDFStream#allowEncryption() */
-    protected boolean allowEncryption() {
-        return false; //XMP metadata packet must be scannable by non PDF-compatible readers
-    }
-
-    /** @return the XMP metadata */
+    /**
+     * @return the XMP metadata
+     */
     public Metadata getMetadata() {
         return this.xmpMetadata;
     }

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

@@ -511,7 +511,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer {
     }
 
     /**
-     * @see org.apache.fop.render.Renderer#stopRenderer(java.io.OutputStream)
+     * @see org.apache.fop.render.Renderer#stopRenderer()
      */
     public void stopRenderer() throws IOException {
         _afpDataStream.endDocument();
@@ -797,7 +797,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer {
 
     /**
      * Clip using the current path.
-     * @see org.apache.fop.render.AbstractRenderer#clip
+     * @see org.apache.fop.render.AbstractPathOrientedRenderer#clip
      */
     public void clip() {
         // TODO
@@ -805,7 +805,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer {
 
     /**
      * Clip using a rectangular area.
-     * @see org.apache.fop.render.AbstractRenderer#clipRect(float, float, float, float)
+     * @see org.apache.fop.render.AbstractPathOrientedRenderer#clipRect(float, float, float, float)
      */
     public void clipRect(float x, float y, float width, float height) {
         // TODO
@@ -813,7 +813,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer {
 
     /**
      * Moves the current point to (x, y), omitting any connecting line segment.
-     * @see org.apache.fop.render.AbstractRenderer#moveTo(float, float)
+     * @see org.apache.fop.render.AbstractPathOrientedRenderer#moveTo(float, float)
      */
     public void moveTo(float x, float y) {
         // TODO
@@ -822,7 +822,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer {
     /**
      * Appends a straight line segment from the current point to (x, y). The
      * new current point is (x, y).
-     * @see org.apache.fop.render.AbstractRenderer#lineTo(float, float)
+     * @see org.apache.fop.render.AbstractPathOrientedRenderer#lineTo(float, float)
      */
     public void lineTo(float x, float y) {
         // TODO
@@ -831,7 +831,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer {
     /**
      * Closes the current subpath by appending a straight line segment from
      * the current point to the starting point of the subpath.
-     * @see org.apache.fop.render.AbstractRenderer#closePath
+     * @see org.apache.fop.render.AbstractPathOrientedRenderer#closePath
      */
     public void closePath() {
         // TODO
@@ -839,7 +839,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer {
 
     /**
      * Fill a rectangular area.
-     * @see org.apache.fop.render.AbstractRenderer#fillRect(float, float, float, float)
+     * @see org.apache.fop.render.AbstractPathOrientedRenderer#fillRect(float, float, float, float)
      */
     public void fillRect(float x, float y, float width, float height) {
         /*
@@ -863,7 +863,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer {
 
     /**
      * Draw a border segment of an XSL-FO style border.
-     * @see org.apache.fop.render.AbstractRenderer#drawBorderLine(float, float, float, float,
+     * @see org.apache.fop.render.AbstractPathOrientedRenderer#drawBorderLine(float, float, float, float,
      *       boolean, boolean, int, Color)
      */
     public void drawBorderLine(float x1, float y1, float x2, float y2,
@@ -1069,7 +1069,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer {
 
     /**
      * Draw an image at the indicated location.
-     * @see org.apache.fop.render.AbstractRenderer#drawImage(String, Rectangle2D, Map)
+     * @see org.apache.fop.render.AbstractPathOrientedRenderer#drawImage(String, Rectangle2D, Map)
      */
     public void drawImage(String url, Rectangle2D pos, Map foreignAttributes) {
         String name = null;
@@ -1256,7 +1256,7 @@ public class AFPRenderer extends AbstractPathOrientedRenderer {
     
     /**
      * Establishes a new foreground or fill color.
-     * @see org.apache.fop.render.AbstractRenderer#updateColor(Color, boolean)
+     * @see org.apache.fop.render.AbstractPathOrientedRenderer#updateColor(Color, boolean)
      */
     public void updateColor(Color col, boolean fill) {
         if (fill) {
@@ -1450,13 +1450,6 @@ public class AFPRenderer extends AbstractPathOrientedRenderer {
         super.renderLeader(area);
     }
 
-    /**
-     * @see org.apache.fop.render.Renderer#setProducer(String)
-     */
-    public void setProducer(String producer) {
-        _afpDataStream.setProducer(producer);
-    }
-
     /**
      * @see org.apache.fop.render.Renderer#setOptions(Map)
      */

src/java/org/apache/fop/render/afp/modca/AFPDataStream.java

@@ -426,16 +426,6 @@ public class AFPDataStream {
 
     }
 
-    /**
-     * Sets the application producing the AFP.
-     *
-     * @param producer
-     *            the application producing the AFP datastream
-     */
-    public void setProducer(String producer) {
-        _producer = producer;
-    }
-
     /**
      * This method will create shading on the page using the specified
      * coordinates (the shading contrast is controlled via the red, green, blue
@@ -648,4 +638,4 @@ public class AFPDataStream {
 
     }
 
-}
+}

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

@@ -474,8 +474,7 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem
     }
 
     /**
-     * @see org.apache.fop.render.AbstractPathOrientedRenderer#updateColor(
-     *          org.apache.fop.datatypes.ColorType, boolean)
+     * @see org.apache.fop.render.AbstractPathOrientedRenderer#updateColor(Color, boolean)
      */
     protected void updateColor(Color col, boolean fill) {
         state.updateColor(col);
@@ -534,9 +533,7 @@ public abstract class Java2DRenderer extends AbstractPathOrientedRenderer implem
     }
     
     /**
-     * @see org.apache.fop.render.AbstractPathOrientedRenderer#drawBorderLine(
-     *          float, float, float, float, boolean, boolean, int, 
-     *          org.apache.fop.datatypes.ColorType)
+     * @see org.apache.fop.render.AbstractPathOrientedRenderer#drawBorderLine(float, float, float, float, boolean, boolean, int, Color)
      */
     protected void drawBorderLine(float x1, float y1, float x2, float y2, 
             boolean horz, boolean startOrBefore, int style, Color col) {

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

@@ -164,7 +164,7 @@ public class Java2DSVGHandler implements XMLHandler, Java2DRendererContextConsta
         info.state.getGraph().setTransform(origTransform);
     }
     
-    /** @see org.apache.fop.render.XMLHandler#supportsRenderer() */
+    /** @see org.apache.fop.render.XMLHandler#supportsRenderer(Renderer) */
     public boolean supportsRenderer(Renderer renderer) {
         return (renderer instanceof Java2DRenderer);
     }

src/java/org/apache/fop/render/xml/XMLRenderer.java

@@ -429,7 +429,7 @@ public class XMLRenderer extends PrintRenderer {
         }
     }
 
-    /** @see org.apache.fop.render.AbstractRenderer#processOffDocumentItem() */
+    /** @see org.apache.fop.render.AbstractRenderer#processOffDocumentItem(OffDocumentItem) */
     public void processOffDocumentItem(OffDocumentItem oDI) {
         if (oDI instanceof OffDocumentExtensionAttachment) {
             ExtensionAttachment attachment = ((OffDocumentExtensionAttachment)oDI).getAttachment();