deac/jquery
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Fixed types for String|Number and added some more @see tags

Browse source
This commit is contained in:
Jörn Zaefferer 2007-01-02 14:35:10 +00:00
parent 651116df95
commit ecf3351792
1 changed files with 19 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
src/fx/fx.js
View file

@ -73,9 +73,11 @@ jQuery.fn.extend({
* *
* @name slideDown * @name slideDown
* @type jQuery * @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. * @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations * @cat Effects/Animations
* @see slideUp(String|Number,Function)
* @see slideToggle(String|Number,Function)
*/ */
slideDown: function(speed,callback){ slideDown: function(speed,callback){
return this.animate({height: "show"}, speed, callback); return this.animate({height: "show"}, speed, callback);
@ -96,9 +98,11 @@ jQuery.fn.extend({
* *
* @name slideUp * @name slideUp
* @type jQuery * @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. * @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations * @cat Effects/Animations
* @see slideDown(String|Number,Function)
* @see slideToggle(String|Number,Function)
*/ */
slideUp: function(speed,callback){ slideUp: function(speed,callback){
return this.animate({height: "hide"}, speed, callback); return this.animate({height: "hide"}, speed, callback);
@ -119,9 +123,11 @@ jQuery.fn.extend({
* *
* @name slideToggle * @name slideToggle
* @type jQuery * @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. * @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations * @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(){ return this.each(function(){
@ -146,9 +152,11 @@ jQuery.fn.extend({
* *
* @name fadeIn * @name fadeIn
* @type jQuery * @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. * @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations * @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); return this.animate({opacity: "show"}, speed, callback);
@ -170,9 +178,11 @@ jQuery.fn.extend({
* *
* @name fadeOut * @name fadeOut
* @type jQuery * @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. * @param Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations * @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); return this.animate({opacity: "hide"}, speed, callback);
@ -194,10 +204,12 @@ jQuery.fn.extend({
* *
* @name fadeTo * @name fadeTo
* @type jQuery * @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 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 Function callback (optional) A function to be executed whenever the animation completes.
* @cat Effects/Animations * @cat Effects/Animations
* @see fadeIn(String|Number,Function)
* @see fadeOut(String|Number,Function)
*/ */
fadeTo: function(speed,to,callback){ fadeTo: function(speed,to,callback){
return this.animate({opacity: to}, speed, callback); return this.animate({opacity: to}, speed, callback);
@ -226,7 +238,7 @@ jQuery.fn.extend({
* @name animate * @name animate
* @type jQuery * @type jQuery
* @param Hash params A set of style attributes that you wish to animate, and to what end. * @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. * @param Function callback A function to be executed whenever the animation completes.
* @cat Effects/Animations * @cat Effects/Animations
*/ */