Fixed up the easing documentation.

diff --git a/src/fx/fx.js b/src/fx/fx.js
index 6f7f9d1ea5a5f68296f270930f6e65ec72a2ca27..36a8c108c5914b6da2e4b0f3a8dcd6470dfd6dcc 100644 (file)
--- a/src/fx/fx.js
+++ b/src/fx/fx.js
@@ -20,7 +20,6 @@ jQuery.fn.extend({
         * @type jQuery\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
-        * @param String easing (optional) easing effect\r
         * @cat Effects\r
         * @see hide(String|Number,Function)\r
         */\r
@@ -50,7 +49,6 @@ jQuery.fn.extend({
         * @type jQuery\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
-        * @param String easing (optional) easing effect\r
         * @cat Effects\r
         * @see show(String|Number,Function)\r
         */\r
@@ -77,7 +75,6 @@ jQuery.fn.extend({
         * @type jQuery\r
         * @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).\r
         * @param Function callback (optional) A function to be executed whenever the animation completes.\r
-        * @param String easing (optional) easing effect\r
         * @cat Effects\r
         * @see slideUp(String|Number,Function)\r
         * @see slideToggle(String|Number,Function)\r
@@ -103,7 +100,6 @@ jQuery.fn.extend({
         * @type jQuery\r
         * @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).\r
         * @param Function callback (optional) A function to be executed whenever the animation completes.\r
-        * @param String easing (optional) easing effect\r
         * @cat Effects\r
         * @see slideDown(String|Number,Function)\r
         * @see slideToggle(String|Number,Function)\r
@@ -129,7 +125,6 @@ jQuery.fn.extend({
         * @type jQuery\r
         * @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).\r
         * @param Function callback (optional) A function to be executed whenever the animation completes.\r
-        * @param String easing (optional) easing effect\r
         * @cat Effects\r
         * @see slideDown(String|Number,Function)\r
         * @see slideUp(String|Number,Function)\r
@@ -159,7 +154,6 @@ jQuery.fn.extend({
         * @type jQuery\r
         * @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).\r
         * @param Function callback (optional) A function to be executed whenever the animation completes.\r
-        * @param String easing (optional) easing effect\r
         * @cat Effects\r
         * @see fadeOut(String|Number,Function)\r
         * @see fadeTo(String|Number,Number,Function)\r
@@ -186,7 +180,6 @@ jQuery.fn.extend({
         * @type jQuery\r
         * @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).\r
         * @param Function callback (optional) A function to be executed whenever the animation completes.\r
-        * @param String easing (optional) easing effect\r
         * @cat Effects\r
         * @see fadeIn(String|Number,Function)\r
         * @see fadeTo(String|Number,Number,Function)\r
@@ -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).\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
-        * @param String easing (optional) easing effect\r
         * @cat Effects\r
         * @see fadeIn(String|Number,Function)\r
         * @see fadeOut(String|Number,Function)\r
@@ -241,14 +233,19 @@ jQuery.fn.extend({
         *\r
         * @example $("p").animate({\r
         *   left: 50, opacity: 'show'\r
-        * }, 500);\r
+        * }, 500);
+        *
+        * @example $("p").animate({\r
+        *   opacity: 'show'\r
+        * }, "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).\r
         *\r
         * @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 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).\r
+        * @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).\r
         * @param Function callback (optional) A function to be executed whenever the animation completes.\r
-        * @param String easing (optional) easing effect\r
         * @cat Effects\r
         */\r
        animate: function( prop, speed, easing, callback ) {\r