Javadoc cleanup flagged by Eclipse

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/branches/FOP_0-20-0_Alt-Design@197123 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/java/org/apache/fop/configuration/Configuration.java b/src/java/org/apache/fop/configuration/Configuration.java
index e6235651db9eba47962c4db59135e8a4270e235b..6e674b9869981cc50f2bc53b7caa4a308d8d9489 100644 (file)
--- a/src/java/org/apache/fop/configuration/Configuration.java
+++ b/src/java/org/apache/fop/configuration/Configuration.java
@@ -324,7 +324,6 @@ public class Configuration {
     /**
      * method to access fonts values in the standard configuration
      *
-     * @param key a string containing the key for the configuration value
      * @return HashMap a HashMap containing the values
      * null   if the key is not defined.
      */

diff --git a/src/java/org/apache/fop/datatypes/Angle.java b/src/java/org/apache/fop/datatypes/Angle.java
index d7b2866f57c78757d61ae6aeb16cad1f641a4544..4f8987e9a8330170ee0b450d7514cdcf130d4014 100644 (file)
--- a/src/java/org/apache/fop/datatypes/Angle.java
+++ b/src/java/org/apache/fop/datatypes/Angle.java
@@ -125,7 +125,7 @@ public class Angle extends AbstractPropertyValue {
     }
 
     /**
-     * @param <tt>int</tt> unit as per constants defined in this class
+     * @param unit type of unit as per constants defined in this class
      * @return <tt>double</tt> degrees value
      */
     public double getAngle(int unit) {
@@ -133,8 +133,8 @@ public class Angle extends AbstractPropertyValue {
     }
 
     /**
-     * @param <tt>int</tt> unit as per constants defined in this class
-     * @param <tt>double</tt> angle in specified units
+     * @param unit  type of unit as per constants defined in this class
+     * @param value  angle in specified units
      */
     public void setAngle(int unit, double value) {
         units = unit;
@@ -142,7 +142,7 @@ public class Angle extends AbstractPropertyValue {
     }
 
     /**
-     * @param <tt>double</tt> angle in degrees
+     * @param degrees  angle in degrees
      */
     public void setAngle(double degrees) {
         units = DEG;

diff --git a/src/java/org/apache/fop/datatypes/Ems.java b/src/java/org/apache/fop/datatypes/Ems.java
index 735b92bc5ec30a4c8a4e4bd2a3e6177c1cabf2d8..f79800f9561191dc0e983a42e8ff065cb10820cf 100644 (file)
--- a/src/java/org/apache/fop/datatypes/Ems.java
+++ b/src/java/org/apache/fop/datatypes/Ems.java
@@ -105,7 +105,6 @@ public class Ems {
      * @param node - the <tt>FONode</tt> with reference to which this
      * <i>EM</i> value is being consructed.  A null value imples the
      * construction of an <i>initial value</i>.
-     * @param property the index of the property with which this value
      * @param propertyName the name of the property with which this value
      * is associated.
      * @param value the number of units.

diff --git a/src/java/org/apache/fop/datatypes/Frequency.java b/src/java/org/apache/fop/datatypes/Frequency.java
index 172619ca7de2b48be6d3a407ba4139640f26dffd..a18aa94088e80419475ec3773a3dadb0ef0a91c6 100644 (file)
--- a/src/java/org/apache/fop/datatypes/Frequency.java
+++ b/src/java/org/apache/fop/datatypes/Frequency.java
@@ -124,7 +124,7 @@ public class Frequency extends AbstractPropertyValue {
     }
 
     /**
-     * @param <tt>int</tt> unit as per constants defined in this class
+     * @param unit type of unit as per constants defined in this class
      * @return <tt>double</tt> frequency value
      */
     public double getFrequency(int unit) {
@@ -132,8 +132,8 @@ public class Frequency extends AbstractPropertyValue {
     }
 
     /**
-     * @param <tt>int</tt> unit as per constants defined in this class
-     * @param <tt>double</tt> frequency in specified units
+     * @param unit type of unit as per constants defined in this class
+     * @param value  frequency in specified units
      */
     public void setFrequency(int unit, double value) {
         units = unit;
@@ -141,7 +141,7 @@ public class Frequency extends AbstractPropertyValue {
     }
 
     /**
-     * @param <tt>double</tt> frequency in hertz
+     * @param frequency  in hertz
      */
     public void setFrequency(double frequency) {
         units = HZ;

diff --git a/src/java/org/apache/fop/datatypes/PropertyValueList.java b/src/java/org/apache/fop/datatypes/PropertyValueList.java
index ffd8d1c43004f76fa3bc361ecb8414696be8e833..7fe7dad9f4f14d9726605b31ce735b2ee7a7a624 100644 (file)
--- a/src/java/org/apache/fop/datatypes/PropertyValueList.java
+++ b/src/java/org/apache/fop/datatypes/PropertyValueList.java
@@ -199,7 +199,6 @@ public class PropertyValueList extends LinkedList implements PropertyValue {
      * Append a PropertyValue to the end of the list.
      * @param o a <tt>PropertyValue</tt>; the element to add.  Defined as an
      * <tt>Object</tt> to override the definition in <tt>LinkedList</tt>.
-     * @return a <tt>boolean</tt> success or failure(?).
      * @exception IllegalArgumentException if the object is not a
      * <tt>PropertyValue</tt>.
      */

diff --git a/src/java/org/apache/fop/datatypes/TextDecorations.java b/src/java/org/apache/fop/datatypes/TextDecorations.java
index 656d292291680d2c1fe094db5a89a704b3162117..9101b9333518b5c5da17ab8d816cf1e389b8190a 100644 (file)
--- a/src/java/org/apache/fop/datatypes/TextDecorations.java
+++ b/src/java/org/apache/fop/datatypes/TextDecorations.java
@@ -123,7 +123,7 @@ public class TextDecorations
 
     /**
      * Set the color associated with this set of decorations.
-     * @param the color.
+     * @param color the color.
      */
     public void setColor(ColorType color) {
         this.color = color;
@@ -132,7 +132,7 @@ public class TextDecorations
     /**
      * Apply the decoration masks of a <tt>TextDecorator</tt> object to
      * these decorations.
-     * @param the <tt>TextDecorator</tt>.
+     * @param decorator the <tt>TextDecorator</tt>.
      */
     public byte maskDecorations(TextDecorator decorator) {
         decorations |= decorator.onMask;

diff --git a/src/java/org/apache/fop/datatypes/Time.java b/src/java/org/apache/fop/datatypes/Time.java
index a74b411284f5e3c463039f6e6c4474a68a1db0d3..80dcd7c8baff290c416b978435c9bb8e3672683e 100644 (file)
--- a/src/java/org/apache/fop/datatypes/Time.java
+++ b/src/java/org/apache/fop/datatypes/Time.java
@@ -125,7 +125,7 @@ public class Time extends AbstractPropertyValue {
     }
 
     /**
-     * @param <tt>int</tt> unit as per constants defined in this class
+     * @param unit type of unit as per constants defined in this class
      * @return <tt>double</tt> time value
      */
     public double getTime(int unit) {
@@ -133,8 +133,8 @@ public class Time extends AbstractPropertyValue {
     }
 
     /**
-     * @param <tt>int</tt> unit as per constants defined in this class
-     * @param <tt>double</tt> time in specified units
+     * @param unit  type of unit as per constants defined in this class
+     * @param value  time in specified units
      */
     public void setTime(int unit, double value) {
         units = unit;
@@ -142,7 +142,7 @@ public class Time extends AbstractPropertyValue {
     }
 
     /**
-     * @param <tt>double</tt> time in millisecs
+     * @param time  in millisecs
      */
     public void setTime(double time) {
         units = MSEC;