aboutsummaryrefslogtreecommitdiffstats
path: root/src/fx/fx.js
diff options
context:
space:
mode:
authorJörn Zaefferer <joern.zaefferer@gmail.com>2007-01-02 14:35:10 +0000
committerJörn Zaefferer <joern.zaefferer@gmail.com>2007-01-02 14:35:10 +0000
commitecf3351792e617a72a5abb22de62400c72906a72 (patch)
tree84949c16b7379cfbbef4b5bf14e1e1b7e50a8cdc /src/fx/fx.js
parent651116df95cb7e77f04d5a6411775c27f627d0ed (diff)
downloadjquery-ecf3351792e617a72a5abb22de62400c72906a72.tar.gz
jquery-ecf3351792e617a72a5abb22de62400c72906a72.zip
Fixed types for String|Number and added some more @see tags
Diffstat (limited to 'src/fx/fx.js')
-rw-r--r--src/fx/fx.js26
1 files changed, 19 insertions, 7 deletions
diff --git a/src/fx/fx.js b/src/fx/fx.js
index e6b599611..4f81aca13 100644
--- a/src/fx/fx.js
+++ b/src/fx/fx.js
@@ -73,9 +73,11 @@ jQuery.fn.extend({
*
* @name slideDown
* @type jQuery
- * @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).
+ * @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).
* @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations
+ * @see slideUp(String|Number,Function)
+ * @see slideToggle(String|Number,Function)
*/
slideDown: function(speed,callback){
return this.animate({height: "show"}, speed, callback);
@@ -96,9 +98,11 @@ jQuery.fn.extend({
*
* @name slideUp
* @type jQuery
- * @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).
+ * @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).
* @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations
+ * @see slideDown(String|Number,Function)
+ * @see slideToggle(String|Number,Function)
*/
slideUp: function(speed,callback){
return this.animate({height: "hide"}, speed, callback);
@@ -119,9 +123,11 @@ jQuery.fn.extend({
*
* @name slideToggle
* @type jQuery
- * @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).
+ * @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).
* @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations
+ * @see slideDown(String|Number,Function)
+ * @see slideUp(String|Number,Function)
*/
slideToggle: function(speed,callback){
return this.each(function(){
@@ -146,9 +152,11 @@ jQuery.fn.extend({
*
* @name fadeIn
* @type jQuery
- * @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).
+ * @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).
* @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations
+ * @see fadeOut(String|Number,Function)
+ * @see fadeTo(String|Number,Number,Function)
*/
fadeIn: function(speed,callback){
return this.animate({opacity: "show"}, speed, callback);
@@ -170,9 +178,11 @@ jQuery.fn.extend({
*
* @name fadeOut
* @type jQuery
- * @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).
+ * @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).
* @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations
+ * @see fadeIn(String|Number,Function)
+ * @see fadeTo(String|Number,Number,Function)
*/
fadeOut: function(speed,callback){
return this.animate({opacity: "hide"}, speed, callback);
@@ -194,10 +204,12 @@ jQuery.fn.extend({
*
* @name fadeTo
* @type jQuery
- * @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).
+ * @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).
* @param Number opacity The opacity to fade to (a number from 0 to 1).
* @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations
+ * @see fadeIn(String|Number,Function)
+ * @see fadeOut(String|Number,Function)
*/
fadeTo: function(speed,to,callback){
return this.animate({opacity: to}, speed, callback);
@@ -226,7 +238,7 @@ jQuery.fn.extend({
* @name animate
* @type jQuery
* @param Hash params A set of style attributes that you wish to animate, and to what end.
- * @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).
+ * @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).
* @param Function callback A function to be executed whenever the animation completes.
* @cat Effects/Animations
*/