From: Ed Engelhardt Date: Tue, 22 May 2007 07:05:32 +0000 (+0000) Subject: improve documentation of animate() function by mentioning both the 'swing' and 'linea... X-Git-Url: http://git.asbjorn.biz/?a=commitdiff_plain;ds=sidebyside;h=d7fe34c440b5b52edd0ebabfa942d560e35224f3;p=jquery.git improve documentation of animate() function by mentioning both the 'swing' and 'linear' easings which are provided by default --- diff --git a/src/fx/fx.js b/src/fx/fx.js index ceeb6d1..af89e93 100644 --- a/src/fx/fx.js +++ b/src/fx/fx.js @@ -295,13 +295,13 @@ jQuery.fn.extend({ * @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). + * @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 "swing" and "linear" are 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 easing (optional) The name of the easing effect that you want to use (e.g. swing or linear). Defaults to "swing". + * @param String easing (optional) The name of the easing effect that you want to use (e.g. "swing" or "linear"). Defaults to "swing". * @param Function callback (optional) A function to be executed whenever the animation completes. * @cat Effects */