From: John Resig Date: Sun, 7 Jan 2007 19:56:29 +0000 (+0000) Subject: Fixed up the easing documentation. X-Git-Tag: 1.1a~15 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=a8f1d0ea4dcd97308a752b81b36ea7329db18881;p=jquery.git Fixed up the easing documentation. --- diff --git a/src/fx/fx.js b/src/fx/fx.js index 6f7f9d1ea..36a8c108c 100644 --- a/src/fx/fx.js +++ b/src/fx/fx.js @@ -20,7 +20,6 @@ jQuery.fn.extend({ * @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 Function callback (optional) A function to be executed whenever the animation completes. - * @param String easing (optional) easing effect * @cat Effects * @see hide(String|Number,Function) */ @@ -50,7 +49,6 @@ jQuery.fn.extend({ * @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 Function callback (optional) A function to be executed whenever the animation completes. - * @param String easing (optional) easing effect * @cat Effects * @see show(String|Number,Function) */ @@ -77,7 +75,6 @@ jQuery.fn.extend({ * @type jQuery * @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. - * @param String easing (optional) easing effect * @cat Effects * @see slideUp(String|Number,Function) * @see slideToggle(String|Number,Function) @@ -103,7 +100,6 @@ jQuery.fn.extend({ * @type jQuery * @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. - * @param String easing (optional) easing effect * @cat Effects * @see slideDown(String|Number,Function) * @see slideToggle(String|Number,Function) @@ -129,7 +125,6 @@ jQuery.fn.extend({ * @type jQuery * @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. - * @param String easing (optional) easing effect * @cat Effects * @see slideDown(String|Number,Function) * @see slideUp(String|Number,Function) @@ -159,7 +154,6 @@ jQuery.fn.extend({ * @type jQuery * @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. - * @param String easing (optional) easing effect * @cat Effects * @see fadeOut(String|Number,Function) * @see fadeTo(String|Number,Number,Function) @@ -186,7 +180,6 @@ jQuery.fn.extend({ * @type jQuery * @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. - * @param String easing (optional) easing effect * @cat Effects * @see fadeIn(String|Number,Function) * @see fadeTo(String|Number,Number,Function) @@ -214,7 +207,6 @@ jQuery.fn.extend({ * @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. - * @param String easing (optional) easing effect * @cat Effects * @see fadeIn(String|Number,Function) * @see fadeOut(String|Number,Function) @@ -241,14 +233,19 @@ jQuery.fn.extend({ * * @example $("p").animate({ * left: 50, opacity: 'show' - * }, 500); + * }, 500); + * + * @example $("p").animate({ + * opacity: 'show' + * }, "slow", "easein"); + * @desc An example of using an 'easing' function to provide a different style of animation. This will only work if you have a plugin that provides this easing function (Only 'linear' is provided by default, with jQuery). * * @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 (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 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 String easing (optional) The name of the easing effect that you want to use (Plugin Required). * @param Function callback (optional) A function to be executed whenever the animation completes. - * @param String easing (optional) easing effect * @cat Effects */ animate: function( prop, speed, easing, callback ) {