Commit 6a47e283 authored by John Resig's avatar John Resig

Updated the docs for a number of methods.

parent db85661c
<html> <html>
<head> <head>
<title>jQuery Documentation</title> <title>jQuery Documentation</title>
<link rel="stylesheet" href="style.css"/> <link rel="stylesheet" href="style/style.css"/>
<script src="../jquery-svn.js"></script> <script src="../jquery-svn.js"></script>
<script src="tooltip.js"></script> <script src="js/tooltip.js"></script>
<script src="pager.js"></script> <script src="js/pager.js"></script>
<script src="jsont.js"></script> <script src="js/jsont.js"></script>
<script src="doc.js"></script> <script src="js/doc.js"></script>
<script src="jquery-docs-jsonp.js"></script> <script src="data/jquery-docs-jsonp.js"></script>
</head> </head>
<body> <body>
<h1>jQuery Docs &raquo; API</h1> <h1>jQuery Docs &raquo; API</h1>
......
This diff is collapsed.
...@@ -13,6 +13,7 @@ jQuery.fn.extend({ ...@@ -13,6 +13,7 @@ jQuery.fn.extend({
* @name show * @name show
* @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 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).
* @cat Effects/Animations
*/ */
/** /**
...@@ -29,6 +30,7 @@ jQuery.fn.extend({ ...@@ -29,6 +30,7 @@ jQuery.fn.extend({
* @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 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 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
*/ */
show: function(speed,callback){ show: function(speed,callback){
return speed ? this.animate({ return speed ? this.animate({
...@@ -49,6 +51,7 @@ jQuery.fn.extend({ ...@@ -49,6 +51,7 @@ jQuery.fn.extend({
* @name hide * @name hide
* @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 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).
* @cat Effects/Animations
*/ */
/** /**
...@@ -65,6 +68,7 @@ jQuery.fn.extend({ ...@@ -65,6 +68,7 @@ jQuery.fn.extend({
* @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 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 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
*/ */
hide: function(speed,callback){ hide: function(speed,callback){
return speed ? this.animate({ return speed ? this.animate({
...@@ -82,6 +86,7 @@ jQuery.fn.extend({ ...@@ -82,6 +86,7 @@ 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 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).
* @cat Effects/Animations
*/ */
/** /**
...@@ -98,6 +103,7 @@ jQuery.fn.extend({ ...@@ -98,6 +103,7 @@ jQuery.fn.extend({
* @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 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 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
*/ */
slideDown: function(speed,callback){ slideDown: function(speed,callback){
return this.animate({height: "show"}, speed, callback); return this.animate({height: "show"}, speed, callback);
...@@ -113,6 +119,7 @@ jQuery.fn.extend({ ...@@ -113,6 +119,7 @@ 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 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).
* @cat Effects/Animations
*/ */
/** /**
...@@ -129,6 +136,7 @@ jQuery.fn.extend({ ...@@ -129,6 +136,7 @@ jQuery.fn.extend({
* @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 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 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
*/ */
slideUp: function(speed,callback){ slideUp: function(speed,callback){
return this.animate({height: "hide"}, speed, callback); return this.animate({height: "hide"}, speed, callback);
...@@ -145,6 +153,7 @@ jQuery.fn.extend({ ...@@ -145,6 +153,7 @@ 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 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).
* @cat Effects/Animations
*/ */
/** /**
...@@ -162,6 +171,7 @@ jQuery.fn.extend({ ...@@ -162,6 +171,7 @@ jQuery.fn.extend({
* @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 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 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
*/ */
fadeIn: function(speed,callback){ fadeIn: function(speed,callback){
return this.animate({opacity: "show"}, speed, callback); return this.animate({opacity: "show"}, speed, callback);
...@@ -178,6 +188,7 @@ jQuery.fn.extend({ ...@@ -178,6 +188,7 @@ 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 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).
* @cat Effects/Animations
*/ */
/** /**
...@@ -195,6 +206,7 @@ jQuery.fn.extend({ ...@@ -195,6 +206,7 @@ jQuery.fn.extend({
* @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 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 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
*/ */
fadeOut: function(speed,callback){ fadeOut: function(speed,callback){
return this.animate({opacity: "hide"}, speed, callback); return this.animate({opacity: "hide"}, speed, callback);
...@@ -212,6 +224,7 @@ jQuery.fn.extend({ ...@@ -212,6 +224,7 @@ jQuery.fn.extend({
* @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 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 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).
* @cat Effects/Animations
*/ */
/** /**
...@@ -230,6 +243,7 @@ jQuery.fn.extend({ ...@@ -230,6 +243,7 @@ jQuery.fn.extend({
* @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 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 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 A function to be executed whenever the animation completes. * @param Function callback A function to be executed whenever the animation completes.
* @cat Effects/Animations
*/ */
fadeTo: function(speed,to,callback){ fadeTo: function(speed,to,callback){
return this.animate({opacity: to}, speed, callback); return this.animate({opacity: to}, speed, callback);
......
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment