pbwest 2004/01/04 18:18:36
Modified: src/java/org/apache/fop/datatypes Tag: FOP_0-20-0_Alt-Design
Frequency.java PropertyValueList.java
TextDecorations.java Ems.java Time.java Angle.java
Log:
Javadoc cleanup flagged by Eclipse
Revision Changes Path
No revision
No revision
1.1.2.2 +5 -5 xml-fop/src/java/org/apache/fop/datatypes/Attic/Frequency.java
Index: Frequency.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/datatypes/Attic/Frequency.java,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- Frequency.java 5 Jul 2003 19:08:19 -0000 1.1.2.1
+++ Frequency.java 5 Jan 2004 02:18:36 -0000 1.1.2.2
@@ -124,7 +124,7 @@
}
/**
- * @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 @@
}
/**
- * @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 @@
}
/**
- * @param <tt>double</tt> frequency in hertz
+ * @param frequency in hertz
*/
public void setFrequency(double frequency) {
units = HZ;
1.1.2.2 +2 -3
xml-fop/src/java/org/apache/fop/datatypes/Attic/PropertyValueList.java
Index: PropertyValueList.java
===================================================================
RCS file:
/home/cvs/xml-fop/src/java/org/apache/fop/datatypes/Attic/PropertyValueList.java,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- PropertyValueList.java 5 Jul 2003 19:08:19 -0000 1.1.2.1
+++ PropertyValueList.java 5 Jan 2004 02:18:36 -0000 1.1.2.2
@@ -199,7 +199,6 @@
* 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>.
*/
1.1.2.2 +5 -5
xml-fop/src/java/org/apache/fop/datatypes/Attic/TextDecorations.java
Index: TextDecorations.java
===================================================================
RCS file:
/home/cvs/xml-fop/src/java/org/apache/fop/datatypes/Attic/TextDecorations.java,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- TextDecorations.java 5 Jul 2003 19:08:19 -0000 1.1.2.1
+++ TextDecorations.java 5 Jan 2004 02:18:36 -0000 1.1.2.2
@@ -123,7 +123,7 @@
/**
* 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 @@
/**
* 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;
1.1.2.2 +3 -4 xml-fop/src/java/org/apache/fop/datatypes/Attic/Ems.java
Index: Ems.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/datatypes/Attic/Ems.java,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- Ems.java 5 Jul 2003 19:08:18 -0000 1.1.2.1
+++ Ems.java 5 Jan 2004 02:18:36 -0000 1.1.2.2
@@ -105,7 +105,6 @@
* @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.
1.1.2.2 +7 -7 xml-fop/src/java/org/apache/fop/datatypes/Attic/Time.java
Index: Time.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/datatypes/Attic/Time.java,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- Time.java 5 Jul 2003 19:08:19 -0000 1.1.2.1
+++ Time.java 5 Jan 2004 02:18:36 -0000 1.1.2.2
@@ -125,7 +125,7 @@
}
/**
- * @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 @@
}
/**
- * @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 @@
}
/**
- * @param <tt>double</tt> time in millisecs
+ * @param time in millisecs
*/
public void setTime(double time) {
units = MSEC;
1.1.2.2 +6 -6 xml-fop/src/java/org/apache/fop/datatypes/Attic/Angle.java
Index: Angle.java
===================================================================
RCS file: /home/cvs/xml-fop/src/java/org/apache/fop/datatypes/Attic/Angle.java,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- Angle.java 5 Jul 2003 19:08:19 -0000 1.1.2.1
+++ Angle.java 5 Jan 2004 02:18:36 -0000 1.1.2.2
@@ -125,7 +125,7 @@
}
/**
- * @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 @@
}
/**
- * @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 @@
}
/**
- * @param <tt>double</tt> angle in degrees
+ * @param degrees angle in degrees
*/
public void setAngle(double degrees) {
units = DEG;
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
