aboutsummaryrefslogtreecommitdiffstats
path: root/src/fx/fx.js
diff options
context:
space:
mode:
authorJörn Zaefferer <joern.zaefferer@gmail.com>2007-01-04 09:47:42 +0000
committerJörn Zaefferer <joern.zaefferer@gmail.com>2007-01-04 09:47:42 +0000
commitdf91317ab43254bb0095482c49de080f5cf4f89e (patch)
tree95065bee3c4e633c9a0470ce0694ee2f089876f9 /src/fx/fx.js
parente0c7e6aec4cf55854217d5c0b2c7069ce84a3d12 (diff)
downloadjquery-df91317ab43254bb0095482c49de080f5cf4f89e.tar.gz
jquery-df91317ab43254bb0095482c49de080f5cf4f89e.zip
Merged the three unbind docs into one, added a few more (optional) hints; Use one() instead of bind() for unload
Diffstat (limited to 'src/fx/fx.js')
-rw-r--r--src/fx/fx.js20
1 files changed, 10 insertions, 10 deletions
diff --git a/src/fx/fx.js b/src/fx/fx.js
index 4f81aca13..dd72c6505 100644
--- a/src/fx/fx.js
+++ b/src/fx/fx.js
@@ -73,7 +73,7 @@ jQuery.fn.extend({
*
* @name slideDown
* @type jQuery
- * @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 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).
* @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations
* @see slideUp(String|Number,Function)
@@ -98,7 +98,7 @@ jQuery.fn.extend({
*
* @name slideUp
* @type jQuery
- * @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 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).
* @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations
* @see slideDown(String|Number,Function)
@@ -123,13 +123,13 @@ jQuery.fn.extend({
*
* @name slideToggle
* @type jQuery
- * @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 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).
* @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){
+ slideToggle: function(speed, callback){
return this.each(function(){
var state = jQuery(this).is(":hidden") ? "show" : "hide";
jQuery(this).animate({height: state}, speed, callback);
@@ -152,13 +152,13 @@ jQuery.fn.extend({
*
* @name fadeIn
* @type jQuery
- * @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 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).
* @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){
+ fadeIn: function(speed, callback){
return this.animate({opacity: "show"}, speed, callback);
},
@@ -178,13 +178,13 @@ jQuery.fn.extend({
*
* @name fadeOut
* @type jQuery
- * @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 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).
* @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){
+ fadeOut: function(speed, callback){
return this.animate({opacity: "hide"}, speed, callback);
},
@@ -238,8 +238,8 @@ 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 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.
+ * @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).
+ * @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations
*/
animate: function(prop,speed,callback) {