Changeset 13190

Timestamp:

03/24/08 20:26:48 (8 months ago)

Author:

peller

Message:

Clean up docs. Refs #5962 !strict

Files:

• dojo/trunk/_base/fx.js (modified) (6 diffs)

dojo/trunk/_base/fx.js

@@ -33 +33 @@
         d.declare("dojo._Animation", null, {
                 //      summary
-                //              A generic animation class that fires callbacks into it's handlers
+                //              A generic animation class that fires callbacks into its handlers
                 //              object at various states. Nearly all dojo animation functions
                 //              return an instance of this method, usually without calling the
@@ -81 +81 @@
                 //
                 // beforeBegin: Event
-                //      Synthetic event fired before a dojo._Animation begins playing (synhcronous)
+                //      Synthetic event fired before a dojo._Animation begins playing (synchronous)
                 beforeBegin: null,
         
@@ -409 +409 @@
         }
 
-        dojo.animateProperty = function(/*Object*/ args){
+        /*=====
+        dojo.declare("dojo.__AnimArgs", [dojo.__FadeArgs], {
+                // Properties: Object?
+                //      A hash map of style properties to Objects describing the transition,
+                //      such as the properties of dojo._Line with an additional 'unit' property
+                properties: {}
+                
+                //TODOC: add event callbacks
+        });
+        =====*/
+
+        dojo.animateProperty = function(/*dojo.__AnimArgs*/ args){
                 //      summary: 
                 //              Returns an animation that will transition the properties of
@@ -420 +431 @@
                 //              style properties, and animates them in parallel over a set
                 //              duration.
-                //      
-                //              args.node can be a String or a DOMNode reference
                 //      
                 //      example:
@@ -524 +533 @@
                                                         /*Integer?*/            delay){
                 //      summary:
-                //              a simpler interface to `dojo.animateProperty()`, also returns
+                //              A simpler interface to `dojo.animateProperty()`, also returns
                 //              an instance of `dojo._Animation` but begins the animation
-                //              immediately unlike nearly every other Dojo animation API.
+                //              immediately, unlike nearly every other Dojo animation API.
                 //      description:
                 //              `dojo.anim` is a simpler (but somewhat less powerful) version
-                //              of `dojo.animateProperty` which defaults many basic properties
+                //              of `dojo.animateProperty`.  It uses defaults for many basic properties
                 //              and allows for positional parameters to be used in place of the
                 //              packed "property bag" which is used for other Dojo animation
@@ -540 +549 @@
                 //              a DOM node or the id of a node to animate CSS properties on
                 //      duration:
-                //              Optional. The number of milliseconds over which the animation
+                //              The number of milliseconds over which the animation
                 //              should run. Defaults to the global animation default duration
                 //              (350ms).
                 //      easing:
-                //              Optional. An easing function over which to calculate
-                //              accelreation and deceleration of the animation through its
-                //              duration. A default easing algorithm is provided, but you may
+                //              An easing function over which to calculate acceleration
+                //              and deceleration of the animation through its duration.
+                //              A default easing algorithm is provided, but you may
                 //              plug in any you wish. A large selection of easing algorithms
                 //              are available in `dojox.fx.easing`.
                 //      onEnd:
-                //              Optional. A function to be called when the animation finishes
+                //              A function to be called when the animation finishes
                 //              running.
                 //      delay:
-                //              Optional. The number of milliseconds to delay beginning the
+                //              The number of milliseconds to delay beginning the
                 //              animation by. The default is 0.
                 //      example: