svn commit: r522297 - /xmlgraphics/batik/trunk/sources/org/apache/batik/dom/svg/AbstractSVGAnimatedLength.java

[dv...@apache.org]

Author: dvholten
Date: Sun Mar 25 09:31:52 2007
New Revision: 522297

URL: http://svn.apache.org/viewvc?view=rev&rev=522297
Log:
fix some javadocs

Modified:
    xmlgraphics/batik/trunk/sources/org/apache/batik/dom/svg/AbstractSVGAnimatedLength.java

Modified: xmlgraphics/batik/trunk/sources/org/apache/batik/dom/svg/AbstractSVGAnimatedLength.java
URL: http://svn.apache.org/viewvc/xmlgraphics/batik/trunk/sources/org/apache/batik/dom/svg/AbstractSVGAnimatedLength.java?view=diff&rev=522297&r1=522296&r2=522297
==============================================================================
--- xmlgraphics/batik/trunk/sources/org/apache/batik/dom/svg/AbstractSVGAnimatedLength.java (original)
+++ xmlgraphics/batik/trunk/sources/org/apache/batik/dom/svg/AbstractSVGAnimatedLength.java Sun Mar 25 09:31:52 2007
@@ -22,6 +22,7 @@
 import org.apache.batik.anim.values.AnimatableValue;
 import org.apache.batik.dom.anim.AnimationTarget;
 import org.apache.batik.parser.UnitProcessor;
+
 import org.w3c.dom.Attr;
 import org.w3c.dom.DOMException;
 import org.w3c.dom.svg.SVGAnimatedLength;
@@ -101,7 +102,7 @@
     }
 
     /**
-     * Returns the default value to use when the associated attribute
+     * @return the default value to use when the associated attribute
      * was not specified.
      */
     protected abstract String getDefaultValue();
@@ -190,7 +191,7 @@
     }
 
     /**
-     * This class represents the SVGLength returned by {@link #getBaseVal()}.
+     * This class represents the SVGLength returned by {@link AbstractSVGAnimatedLength#getBaseVal() }.
      */
     protected class BaseSVGLength extends AbstractSVGLength {
 
@@ -201,6 +202,7 @@
 
         /**
          * Creates a new BaseSVGLength.
+         * @param direction is one of HORIZONTAL_LENGTH, VERTICAL_LENGTH, or OTHER_LENGTH
          */
         public BaseSVGLength(short direction) {
             super(direction);
@@ -270,12 +272,13 @@
     }
 
     /**
-     * This class represents the SVGLength returned by {@link #getAnimVal()}.
+     * This class represents the SVGLength returned by {@link AbstractSVGAnimatedLength#getAnimVal()}.
      */
     protected class AnimSVGLength extends AbstractSVGLength {
 
         /**
          * Creates a new AnimSVGLength.
+         * @param direction is one of HORIZONTAL_LENGTH, VERTICAL_LENGTH, or OTHER_LENGTH
          */
         public AnimSVGLength(short direction) {
             super(direction);
@@ -378,6 +381,8 @@
 
         /**
          * Sets the animated value.
+         * @param type one of the values defines in org.w3c.dom.svg.SVGLength
+         * @param val the length
          */
         protected void setAnimatedValue(int type, float val) {
             super.newValueSpecifiedUnits((short) type, val);