Merged the three unbind docs into one, added a few more (optional) hints; Use one...

[jquery.git] / src / fx / fx.js

diff --git a/src/fx/fx.js b/src/fx/fx.js
index e6b5996..dd72c65 100644 (file)
--- a/src/fx/fx.js
+++ b/src/fx/fx.js
@@ -73,9 +73,11 @@ jQuery.fn.extend({
         *\r
         * @name slideDown\r
         * @type jQuery\r
-        * @param Object speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).\r
+        * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).\r
         * @param Function callback (optional) A function to be executed whenever the animation completes.\r
         * @cat Effects/Animations\r
+        * @see slideUp(String|Number,Function)\r
+        * @see slideToggle(String|Number,Function)\r
         */\r
        slideDown: function(speed,callback){\r
                return this.animate({height: "show"}, speed, callback);\r
@@ -96,9 +98,11 @@ jQuery.fn.extend({
         *\r
         * @name slideUp\r
         * @type jQuery\r
-        * @param Object speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).\r
+        * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).\r
         * @param Function callback (optional) A function to be executed whenever the animation completes.\r
         * @cat Effects/Animations\r
+        * @see slideDown(String|Number,Function)\r
+        * @see slideToggle(String|Number,Function)\r
         */\r
        slideUp: function(speed,callback){\r
                return this.animate({height: "hide"}, speed, callback);\r
@@ -119,11 +123,13 @@ jQuery.fn.extend({
         *\r
         * @name slideToggle\r
         * @type jQuery\r
-        * @param Object speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).\r
+        * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).\r
         * @param Function callback (optional) A function to be executed whenever the animation completes.\r
         * @cat Effects/Animations\r
+        * @see slideDown(String|Number,Function)\r
+        * @see slideUp(String|Number,Function)\r
         */\r
-       slideToggle: function(speed,callback){\r
+       slideToggle: function(speed, callback){\r
                return this.each(function(){\r
                        var state = jQuery(this).is(":hidden") ? "show" : "hide";\r
                        jQuery(this).animate({height: state}, speed, callback);\r
@@ -146,11 +152,13 @@ jQuery.fn.extend({
         *\r
         * @name fadeIn\r
         * @type jQuery\r
-        * @param Object speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).\r
+        * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).\r
         * @param Function callback (optional) A function to be executed whenever the animation completes.\r
         * @cat Effects/Animations\r
+        * @see fadeOut(String|Number,Function)\r
+        * @see fadeTo(String|Number,Number,Function)\r
         */\r
-       fadeIn: function(speed,callback){\r
+       fadeIn: function(speed, callback){\r
                return this.animate({opacity: "show"}, speed, callback);\r
        },\r
        \r
@@ -170,11 +178,13 @@ jQuery.fn.extend({
         *\r
         * @name fadeOut\r
         * @type jQuery\r
-        * @param Object speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).\r
+        * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).\r
         * @param Function callback (optional) A function to be executed whenever the animation completes.\r
         * @cat Effects/Animations\r
+        * @see fadeIn(String|Number,Function)\r
+        * @see fadeTo(String|Number,Number,Function)\r
         */\r
-       fadeOut: function(speed,callback){\r
+       fadeOut: function(speed, callback){\r
                return this.animate({opacity: "hide"}, speed, callback);\r
        },\r
        \r
@@ -194,10 +204,12 @@ jQuery.fn.extend({
         *\r
         * @name fadeTo\r
         * @type jQuery\r
-        * @param Object speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).\r
+        * @param String|Number speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).\r
         * @param Number opacity The opacity to fade to (a number from 0 to 1).\r
         * @param Function callback (optional) A function to be executed whenever the animation completes.\r
         * @cat Effects/Animations\r
+        * @see fadeIn(String|Number,Function)\r
+        * @see fadeOut(String|Number,Function)\r
         */\r
        fadeTo: function(speed,to,callback){\r
                return this.animate({opacity: to}, speed, callback);\r
@@ -226,8 +238,8 @@ jQuery.fn.extend({
         * @name animate\r
         * @type jQuery\r
         * @param Hash params A set of style attributes that you wish to animate, and to what end.\r
-        * @param Object speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).\r
-        * @param Function callback A function to be executed whenever the animation completes.\r
+        * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000).\r
+        * @param Function callback (optional) A function to be executed whenever the animation completes.\r
         * @cat Effects/Animations\r
         */\r
        animate: function(prop,speed,callback) {\r