Fixed types for String|Number and added some more @see tags
authorJörn Zaefferer <joern.zaefferer@gmail.com>
Tue, 2 Jan 2007 14:35:10 +0000 (14:35 +0000)
committerJörn Zaefferer <joern.zaefferer@gmail.com>
Tue, 2 Jan 2007 14:35:10 +0000 (14:35 +0000)
src/fx/fx.js

index e6b5996..4f81aca 100644 (file)
@@ -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 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 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,9 +123,11 @@ 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 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
                return this.each(function(){\r
@@ -146,9 +152,11 @@ 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 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
                return this.animate({opacity: "show"}, speed, callback);\r
@@ -170,9 +178,11 @@ 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 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
                return this.animate({opacity: "hide"}, speed, callback);\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,7 +238,7 @@ 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 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 Function callback A function to be executed whenever the animation completes.\r
         * @cat Effects/Animations\r
         */\r