diff --git a/docs/index.html b/docs/index.html index 1edb678d46..b31249964c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,13 +1,13 @@ jQuery Documentation - + - - - - - + + + + +

jQuery Docs » API

diff --git a/event/event.js b/event/event.js index 9094e73ac0..43d5d05e41 100644 --- a/event/event.js +++ b/event/event.js @@ -20,6 +20,7 @@ jQuery.fn.extend({ * @type jQuery * @param Function even The function to execute on every even click. * @param Function odd The function to execute on every odd click. + * @cat Events */ toggle: function(a,b) { // If two functions are passed in, we're @@ -62,6 +63,7 @@ jQuery.fn.extend({ * @type jQuery * @param Function over The function to fire whenever the mouse is moved over a matched element. * @param Function out The function to fire whenever the mouse is moved off of a matched element. + * @cat Events */ hover: function(f,g) { @@ -95,7 +97,7 @@ jQuery.fn.extend({ * will be called the instant the DOM is ready to be read and manipulated, * which is exactly what 99.99% of all Javascript code needs to run. * - * Please ensure you have no code in your onload event handler, + * Please ensure you have no code in your <body> onload event handler, * otherwise $(document).ready() may not fire. * * @example $(document).ready(function(){ Your code here... }); @@ -103,6 +105,7 @@ jQuery.fn.extend({ * @name ready * @type jQuery * @param Function fn The function to be executed when the DOM is ready. + * @cat Events */ ready: function(f) { // If the DOM is already ready @@ -159,6 +162,7 @@ new function(){ * @name blur * @type jQuery * @param Function fn A function to bind to the blur event on each of the matched elements. + * @cat Events */ /** @@ -171,6 +175,7 @@ new function(){ * * @name blur * @type jQuery + * @cat Events */ /** @@ -185,6 +190,7 @@ new function(){ * @name oneblur * @type jQuery * @param Function fn A function to bind to the blur event on each of the matched elements. + * @cat Events */ /** @@ -199,6 +205,7 @@ new function(){ * @name unblur * @type jQuery * @param Function fn A function to unbind from the blur event on each of the matched elements. + * @cat Events */ /** @@ -210,6 +217,7 @@ new function(){ * * @name unblur * @type jQuery + * @cat Events */ /** @@ -222,6 +230,7 @@ new function(){ * @name focus * @type jQuery * @param Function fn A function to bind to the focus event on each of the matched elements. + * @cat Events */ /** @@ -234,6 +243,7 @@ new function(){ * * @name focus * @type jQuery + * @cat Events */ /** @@ -248,6 +258,7 @@ new function(){ * @name onefocus * @type jQuery * @param Function fn A function to bind to the focus event on each of the matched elements. + * @cat Events */ /** @@ -262,6 +273,7 @@ new function(){ * @name unfocus * @type jQuery * @param Function fn A function to unbind from the focus event on each of the matched elements. + * @cat Events */ /** @@ -273,6 +285,7 @@ new function(){ * * @name unfocus * @type jQuery + * @cat Events */ /** @@ -285,6 +298,7 @@ new function(){ * @name load * @type jQuery * @param Function fn A function to bind to the load event on each of the matched elements. + * @cat Events */ /** @@ -297,6 +311,7 @@ new function(){ * * @name load * @type jQuery + * @cat Events */ /** @@ -311,6 +326,7 @@ new function(){ * @name oneload * @type jQuery * @param Function fn A function to bind to the load event on each of the matched elements. + * @cat Events */ /** @@ -325,6 +341,7 @@ new function(){ * @name unload * @type jQuery * @param Function fn A function to unbind from the load event on each of the matched elements. + * @cat Events */ /** @@ -336,6 +353,7 @@ new function(){ * * @name unload * @type jQuery + * @cat Events */ /** @@ -348,6 +366,7 @@ new function(){ * @name resize * @type jQuery * @param Function fn A function to bind to the resize event on each of the matched elements. + * @cat Events */ /** @@ -360,6 +379,7 @@ new function(){ * * @name resize * @type jQuery + * @cat Events */ /** @@ -374,6 +394,7 @@ new function(){ * @name oneresize * @type jQuery * @param Function fn A function to bind to the resize event on each of the matched elements. + * @cat Events */ /** @@ -388,6 +409,7 @@ new function(){ * @name unresize * @type jQuery * @param Function fn A function to unbind from the resize event on each of the matched elements. + * @cat Events */ /** @@ -399,6 +421,7 @@ new function(){ * * @name unresize * @type jQuery + * @cat Events */ /** @@ -411,6 +434,7 @@ new function(){ * @name scroll * @type jQuery * @param Function fn A function to bind to the scroll event on each of the matched elements. + * @cat Events */ /** @@ -423,6 +447,7 @@ new function(){ * * @name scroll * @type jQuery + * @cat Events */ /** @@ -437,6 +462,7 @@ new function(){ * @name onescroll * @type jQuery * @param Function fn A function to bind to the scroll event on each of the matched elements. + * @cat Events */ /** @@ -451,6 +477,7 @@ new function(){ * @name unscroll * @type jQuery * @param Function fn A function to unbind from the scroll event on each of the matched elements. + * @cat Events */ /** @@ -462,6 +489,7 @@ new function(){ * * @name unscroll * @type jQuery + * @cat Events */ /** @@ -474,6 +502,7 @@ new function(){ * @name unload * @type jQuery * @param Function fn A function to bind to the unload event on each of the matched elements. + * @cat Events */ /** @@ -486,6 +515,7 @@ new function(){ * * @name unload * @type jQuery + * @cat Events */ /** @@ -500,6 +530,7 @@ new function(){ * @name oneunload * @type jQuery * @param Function fn A function to bind to the unload event on each of the matched elements. + * @cat Events */ /** @@ -514,6 +545,7 @@ new function(){ * @name ununload * @type jQuery * @param Function fn A function to unbind from the unload event on each of the matched elements. + * @cat Events */ /** @@ -525,6 +557,7 @@ new function(){ * * @name ununload * @type jQuery + * @cat Events */ /** @@ -537,6 +570,7 @@ new function(){ * @name click * @type jQuery * @param Function fn A function to bind to the click event on each of the matched elements. + * @cat Events */ /** @@ -549,6 +583,7 @@ new function(){ * * @name click * @type jQuery + * @cat Events */ /** @@ -563,6 +598,7 @@ new function(){ * @name oneclick * @type jQuery * @param Function fn A function to bind to the click event on each of the matched elements. + * @cat Events */ /** @@ -577,6 +613,7 @@ new function(){ * @name unclick * @type jQuery * @param Function fn A function to unbind from the click event on each of the matched elements. + * @cat Events */ /** @@ -588,6 +625,7 @@ new function(){ * * @name unclick * @type jQuery + * @cat Events */ /** @@ -600,6 +638,7 @@ new function(){ * @name dblclick * @type jQuery * @param Function fn A function to bind to the dblclick event on each of the matched elements. + * @cat Events */ /** @@ -612,6 +651,7 @@ new function(){ * * @name dblclick * @type jQuery + * @cat Events */ /** @@ -626,6 +666,7 @@ new function(){ * @name onedblclick * @type jQuery * @param Function fn A function to bind to the dblclick event on each of the matched elements. + * @cat Events */ /** @@ -640,6 +681,7 @@ new function(){ * @name undblclick * @type jQuery * @param Function fn A function to unbind from the dblclick event on each of the matched elements. + * @cat Events */ /** @@ -651,6 +693,7 @@ new function(){ * * @name undblclick * @type jQuery + * @cat Events */ /** @@ -663,6 +706,7 @@ new function(){ * @name mousedown * @type jQuery * @param Function fn A function to bind to the mousedown event on each of the matched elements. + * @cat Events */ /** @@ -675,6 +719,7 @@ new function(){ * * @name mousedown * @type jQuery + * @cat Events */ /** @@ -689,6 +734,7 @@ new function(){ * @name onemousedown * @type jQuery * @param Function fn A function to bind to the mousedown event on each of the matched elements. + * @cat Events */ /** @@ -703,6 +749,7 @@ new function(){ * @name unmousedown * @type jQuery * @param Function fn A function to unbind from the mousedown event on each of the matched elements. + * @cat Events */ /** @@ -714,6 +761,7 @@ new function(){ * * @name unmousedown * @type jQuery + * @cat Events */ /** @@ -726,6 +774,7 @@ new function(){ * @name mouseup * @type jQuery * @param Function fn A function to bind to the mouseup event on each of the matched elements. + * @cat Events */ /** @@ -738,6 +787,7 @@ new function(){ * * @name mouseup * @type jQuery + * @cat Events */ /** @@ -752,6 +802,7 @@ new function(){ * @name onemouseup * @type jQuery * @param Function fn A function to bind to the mouseup event on each of the matched elements. + * @cat Events */ /** @@ -766,6 +817,7 @@ new function(){ * @name unmouseup * @type jQuery * @param Function fn A function to unbind from the mouseup event on each of the matched elements. + * @cat Events */ /** @@ -777,6 +829,7 @@ new function(){ * * @name unmouseup * @type jQuery + * @cat Events */ /** @@ -789,6 +842,7 @@ new function(){ * @name mousemove * @type jQuery * @param Function fn A function to bind to the mousemove event on each of the matched elements. + * @cat Events */ /** @@ -801,6 +855,7 @@ new function(){ * * @name mousemove * @type jQuery + * @cat Events */ /** @@ -815,6 +870,7 @@ new function(){ * @name onemousemove * @type jQuery * @param Function fn A function to bind to the mousemove event on each of the matched elements. + * @cat Events */ /** @@ -829,6 +885,7 @@ new function(){ * @name unmousemove * @type jQuery * @param Function fn A function to unbind from the mousemove event on each of the matched elements. + * @cat Events */ /** @@ -840,6 +897,7 @@ new function(){ * * @name unmousemove * @type jQuery + * @cat Events */ /** @@ -852,6 +910,7 @@ new function(){ * @name mouseover * @type jQuery * @param Function fn A function to bind to the mouseover event on each of the matched elements. + * @cat Events */ /** @@ -864,6 +923,7 @@ new function(){ * * @name mouseover * @type jQuery + * @cat Events */ /** @@ -878,6 +938,7 @@ new function(){ * @name onemouseover * @type jQuery * @param Function fn A function to bind to the mouseover event on each of the matched elements. + * @cat Events */ /** @@ -892,6 +953,7 @@ new function(){ * @name unmouseover * @type jQuery * @param Function fn A function to unbind from the mouseover event on each of the matched elements. + * @cat Events */ /** @@ -903,6 +965,7 @@ new function(){ * * @name unmouseover * @type jQuery + * @cat Events */ /** @@ -915,6 +978,7 @@ new function(){ * @name mouseout * @type jQuery * @param Function fn A function to bind to the mouseout event on each of the matched elements. + * @cat Events */ /** @@ -927,6 +991,7 @@ new function(){ * * @name mouseout * @type jQuery + * @cat Events */ /** @@ -941,6 +1006,7 @@ new function(){ * @name onemouseout * @type jQuery * @param Function fn A function to bind to the mouseout event on each of the matched elements. + * @cat Events */ /** @@ -955,6 +1021,7 @@ new function(){ * @name unmouseout * @type jQuery * @param Function fn A function to unbind from the mouseout event on each of the matched elements. + * @cat Events */ /** @@ -966,6 +1033,7 @@ new function(){ * * @name unmouseout * @type jQuery + * @cat Events */ /** @@ -978,6 +1046,7 @@ new function(){ * @name change * @type jQuery * @param Function fn A function to bind to the change event on each of the matched elements. + * @cat Events */ /** @@ -990,6 +1059,7 @@ new function(){ * * @name change * @type jQuery + * @cat Events */ /** @@ -1004,6 +1074,7 @@ new function(){ * @name onechange * @type jQuery * @param Function fn A function to bind to the change event on each of the matched elements. + * @cat Events */ /** @@ -1018,6 +1089,7 @@ new function(){ * @name unchange * @type jQuery * @param Function fn A function to unbind from the change event on each of the matched elements. + * @cat Events */ /** @@ -1029,6 +1101,7 @@ new function(){ * * @name unchange * @type jQuery + * @cat Events */ /** @@ -1041,6 +1114,7 @@ new function(){ * @name reset * @type jQuery * @param Function fn A function to bind to the reset event on each of the matched elements. + * @cat Events */ /** @@ -1053,6 +1127,7 @@ new function(){ * * @name reset * @type jQuery + * @cat Events */ /** @@ -1067,6 +1142,7 @@ new function(){ * @name onereset * @type jQuery * @param Function fn A function to bind to the reset event on each of the matched elements. + * @cat Events */ /** @@ -1081,6 +1157,7 @@ new function(){ * @name unreset * @type jQuery * @param Function fn A function to unbind from the reset event on each of the matched elements. + * @cat Events */ /** @@ -1092,6 +1169,7 @@ new function(){ * * @name unreset * @type jQuery + * @cat Events */ /** @@ -1104,6 +1182,7 @@ new function(){ * @name select * @type jQuery * @param Function fn A function to bind to the select event on each of the matched elements. + * @cat Events */ /** @@ -1116,6 +1195,7 @@ new function(){ * * @name select * @type jQuery + * @cat Events */ /** @@ -1130,6 +1210,7 @@ new function(){ * @name oneselect * @type jQuery * @param Function fn A function to bind to the select event on each of the matched elements. + * @cat Events */ /** @@ -1144,6 +1225,7 @@ new function(){ * @name unselect * @type jQuery * @param Function fn A function to unbind from the select event on each of the matched elements. + * @cat Events */ /** @@ -1155,6 +1237,7 @@ new function(){ * * @name unselect * @type jQuery + * @cat Events */ /** @@ -1167,6 +1250,7 @@ new function(){ * @name submit * @type jQuery * @param Function fn A function to bind to the submit event on each of the matched elements. + * @cat Events */ /** @@ -1179,6 +1263,7 @@ new function(){ * * @name submit * @type jQuery + * @cat Events */ /** @@ -1193,6 +1278,7 @@ new function(){ * @name onesubmit * @type jQuery * @param Function fn A function to bind to the submit event on each of the matched elements. + * @cat Events */ /** @@ -1207,6 +1293,7 @@ new function(){ * @name unsubmit * @type jQuery * @param Function fn A function to unbind from the submit event on each of the matched elements. + * @cat Events */ /** @@ -1218,6 +1305,7 @@ new function(){ * * @name unsubmit * @type jQuery + * @cat Events */ /** @@ -1230,6 +1318,7 @@ new function(){ * @name keydown * @type jQuery * @param Function fn A function to bind to the keydown event on each of the matched elements. + * @cat Events */ /** @@ -1242,6 +1331,7 @@ new function(){ * * @name keydown * @type jQuery + * @cat Events */ /** @@ -1256,6 +1346,7 @@ new function(){ * @name onekeydown * @type jQuery * @param Function fn A function to bind to the keydown event on each of the matched elements. + * @cat Events */ /** @@ -1270,6 +1361,7 @@ new function(){ * @name unkeydown * @type jQuery * @param Function fn A function to unbind from the keydown event on each of the matched elements. + * @cat Events */ /** @@ -1281,6 +1373,7 @@ new function(){ * * @name unkeydown * @type jQuery + * @cat Events */ /** @@ -1293,6 +1386,7 @@ new function(){ * @name keypress * @type jQuery * @param Function fn A function to bind to the keypress event on each of the matched elements. + * @cat Events */ /** @@ -1305,6 +1399,7 @@ new function(){ * * @name keypress * @type jQuery + * @cat Events */ /** @@ -1319,6 +1414,7 @@ new function(){ * @name onekeypress * @type jQuery * @param Function fn A function to bind to the keypress event on each of the matched elements. + * @cat Events */ /** @@ -1333,6 +1429,7 @@ new function(){ * @name unkeypress * @type jQuery * @param Function fn A function to unbind from the keypress event on each of the matched elements. + * @cat Events */ /** @@ -1344,6 +1441,7 @@ new function(){ * * @name unkeypress * @type jQuery + * @cat Events */ /** @@ -1356,6 +1454,7 @@ new function(){ * @name keyup * @type jQuery * @param Function fn A function to bind to the keyup event on each of the matched elements. + * @cat Events */ /** @@ -1368,6 +1467,7 @@ new function(){ * * @name keyup * @type jQuery + * @cat Events */ /** @@ -1382,6 +1482,7 @@ new function(){ * @name onekeyup * @type jQuery * @param Function fn A function to bind to the keyup event on each of the matched elements. + * @cat Events */ /** @@ -1396,6 +1497,7 @@ new function(){ * @name unkeyup * @type jQuery * @param Function fn A function to unbind from the keyup event on each of the matched elements. + * @cat Events */ /** @@ -1407,6 +1509,7 @@ new function(){ * * @name unkeyup * @type jQuery + * @cat Events */ /** @@ -1419,6 +1522,7 @@ new function(){ * @name error * @type jQuery * @param Function fn A function to bind to the error event on each of the matched elements. + * @cat Events */ /** @@ -1431,6 +1535,7 @@ new function(){ * * @name error * @type jQuery + * @cat Events */ /** @@ -1445,6 +1550,7 @@ new function(){ * @name oneerror * @type jQuery * @param Function fn A function to bind to the error event on each of the matched elements. + * @cat Events */ /** @@ -1459,6 +1565,7 @@ new function(){ * @name unerror * @type jQuery * @param Function fn A function to unbind from the error event on each of the matched elements. + * @cat Events */ /** @@ -1470,6 +1577,7 @@ new function(){ * * @name unerror * @type jQuery + * @cat Events */ var e = ("blur,focus,load,resize,scroll,unload,click,dblclick," + diff --git a/fx/fx.js b/fx/fx.js index 1929388965..45cc2d917c 100644 --- a/fx/fx.js +++ b/fx/fx.js @@ -13,6 +13,7 @@ jQuery.fn.extend({ * @name show * @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). + * @cat Effects/Animations */ /** @@ -29,6 +30,7 @@ jQuery.fn.extend({ * @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 Function callback A function to be executed whenever the animation completes. + * @cat Effects/Animations */ show: function(speed,callback){ return speed ? this.animate({ @@ -49,6 +51,7 @@ jQuery.fn.extend({ * @name hide * @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). + * @cat Effects/Animations */ /** @@ -65,6 +68,7 @@ jQuery.fn.extend({ * @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 Function callback A function to be executed whenever the animation completes. + * @cat Effects/Animations */ hide: function(speed,callback){ return speed ? this.animate({ @@ -82,6 +86,7 @@ jQuery.fn.extend({ * @name slideDown * @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). + * @cat Effects/Animations */ /** @@ -98,6 +103,7 @@ jQuery.fn.extend({ * @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 Function callback A function to be executed whenever the animation completes. + * @cat Effects/Animations */ slideDown: function(speed,callback){ return this.animate({height: "show"}, speed, callback); @@ -113,6 +119,7 @@ jQuery.fn.extend({ * @name slideUp * @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). + * @cat Effects/Animations */ /** @@ -129,6 +136,7 @@ jQuery.fn.extend({ * @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 Function callback A function to be executed whenever the animation completes. + * @cat Effects/Animations */ slideUp: function(speed,callback){ return this.animate({height: "hide"}, speed, callback); @@ -145,6 +153,7 @@ jQuery.fn.extend({ * @name fadeIn * @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). + * @cat Effects/Animations */ /** @@ -162,6 +171,7 @@ jQuery.fn.extend({ * @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 Function callback A function to be executed whenever the animation completes. + * @cat Effects/Animations */ fadeIn: function(speed,callback){ return this.animate({opacity: "show"}, speed, callback); @@ -178,6 +188,7 @@ jQuery.fn.extend({ * @name fadeOut * @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). + * @cat Effects/Animations */ /** @@ -195,6 +206,7 @@ jQuery.fn.extend({ * @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 Function callback A function to be executed whenever the animation completes. + * @cat Effects/Animations */ fadeOut: function(speed,callback){ return this.animate({opacity: "hide"}, speed, callback); @@ -212,6 +224,7 @@ jQuery.fn.extend({ * @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 Number opacity The opacity to fade to (a number from 0 to 1). + * @cat Effects/Animations */ /** @@ -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 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. + * @cat Effects/Animations */ fadeTo: function(speed,to,callback){ return this.animate({opacity: to}, speed, callback); diff --git a/jquery/jquery.js b/jquery/jquery.js index ebf1038658..a0146c3721 100644 --- a/jquery/jquery.js +++ b/jquery/jquery.js @@ -91,6 +91,7 @@ jQuery.fn = jQuery.prototype = { * @property * @name jquery * @type String + * @cat Core */ jquery: "$Rev$", @@ -104,6 +105,7 @@ jQuery.fn = jQuery.prototype = { * @property * @name length * @type Number + * @cat Core */ /** @@ -115,6 +117,7 @@ jQuery.fn = jQuery.prototype = { * * @name size * @type Number + * @cat Core */ size: function() { return this.length; @@ -131,11 +134,12 @@ jQuery.fn = jQuery.prototype = { * * @name get * @type Array + * @cat Core */ /** - * Access a single matched element. num is used to access the - * numth element matched. + * Access a single matched element. num is used to access the + * Nth element matched. * * @example $("img").get(1); * @before @@ -143,7 +147,8 @@ jQuery.fn = jQuery.prototype = { * * @name get * @type Element - * @param Number num Access the element in the numth position. + * @param Number num Access the element in the Nth position. + * @cat Core */ /** @@ -156,6 +161,7 @@ jQuery.fn = jQuery.prototype = { * @name get * @type jQuery * @param Elements elems An array of elements + * @cat Core */ get: function( num ) { // Watch for when an array (of elements) is passed in @@ -194,6 +200,7 @@ jQuery.fn = jQuery.prototype = { * @name each * @type jQuery * @param Function fn A function to execute + * @cat Core */ each: function( fn, args ) { return jQuery.each( this, fn, args ); @@ -211,6 +218,7 @@ jQuery.fn = jQuery.prototype = { * @name attr * @type Object * @param String name The name of the property to access. + * @cat DOM */ /** @@ -225,6 +233,7 @@ jQuery.fn = jQuery.prototype = { * @name attr * @type jQuery * @param Hash prop A set of key/value pairs to set as object properties. + * @cat DOM */ /** @@ -238,6 +247,7 @@ jQuery.fn = jQuery.prototype = { * @type jQuery * @param String key The name of the property to set. * @param Object value The value to set the property to. + * @cat DOM */ attr: function( key, value, type ) { // Check to see if we're setting style values @@ -276,6 +286,7 @@ jQuery.fn = jQuery.prototype = { * @name css * @type Object * @param String name The name of the property to access. + * @cat CSS */ /** @@ -290,6 +301,7 @@ jQuery.fn = jQuery.prototype = { * @name css * @type jQuery * @param Hash prop A set of key/value pairs to set as style properties. + * @cat CSS */ /** @@ -303,6 +315,7 @@ jQuery.fn = jQuery.prototype = { * @type jQuery * @param String key The name of the property to set. * @param Object value The value to set the property to. + * @cat CSS */ css: function( key, value ) { return this.attr( key, value, "curCSS" ); @@ -319,6 +332,7 @@ jQuery.fn = jQuery.prototype = { * * @name text * @type String + * @cat DOM */ text: function(e) { e = e || this; @@ -352,6 +366,7 @@ jQuery.fn = jQuery.prototype = { * @any Element elem A DOM element that will be wrapped. * @any Array elems An array of elements, the first of which will be wrapped. * @any Object obj Any object, converted to a string, then a text node. + * @cat DOM/Manipulation */ wrap: function() { // The elements to wrap the target around @@ -376,7 +391,7 @@ jQuery.fn = jQuery.prototype = { /** * Append any number of elements to the inside of all matched elements. - * This operation is similar to doing an appendChild to all the + * This operation is similar to doing an appendChild to all the * specified elements, adding them into the document. * * @example $("p").append("Hello"); @@ -389,6 +404,7 @@ jQuery.fn = jQuery.prototype = { * @any Element elem A DOM element that will be appended. * @any Array elems An array of elements, all of which will be appended. * @any Object obj Any object, converted to a string, then a text node. + * @cat DOM/Manipulation */ append: function() { return this.domManip(arguments, true, 1, function(a){ @@ -411,6 +427,7 @@ jQuery.fn = jQuery.prototype = { * @any Element elem A DOM element that will be prepended. * @any Array elems An array of elements, all of which will be prepended. * @any Object obj Any object, converted to a string, then a text node. + * @cat DOM/Manipulation */ prepend: function() { return this.domManip(arguments, true, -1, function(a){ @@ -431,6 +448,7 @@ jQuery.fn = jQuery.prototype = { * @any Element elem A DOM element that will beinserted. * @any Array elems An array of elements, all of which will be inserted. * @any Object obj Any object, converted to a string, then a text node. + * @cat DOM/Manipulation */ before: function() { return this.domManip(arguments, false, 1, function(a){ @@ -451,6 +469,7 @@ jQuery.fn = jQuery.prototype = { * @any Element elem A DOM element that will beinserted. * @any Array elems An array of elements, all of which will be inserted. * @any Object obj Any object, converted to a string, then a text node. + * @cat DOM/Manipulation */ after: function() { return this.domManip(arguments, false, -1, function(a){ @@ -469,6 +488,7 @@ jQuery.fn = jQuery.prototype = { * * @name end * @type jQuery + * @cat DOM/Traversing */ end: function() { return this.get( this.stack.pop() ); @@ -489,6 +509,7 @@ jQuery.fn = jQuery.prototype = { * @name find * @type jQuery * @param String expr An expression to search with. + * @cat DOM/Traversing */ find: function(t) { return this.pushStack( jQuery.map( this, function(a){ @@ -511,6 +532,7 @@ jQuery.fn = jQuery.prototype = { * @name filter * @type jQuery * @param String expr An expression to search with. + * @cat DOM/Traversing */ /** @@ -529,6 +551,7 @@ jQuery.fn = jQuery.prototype = { * @name filter * @type jQuery * @param Array exprs A set of expressions to evaluate against + * @cat DOM/Traversing */ filter: function(t) { return this.pushStack( @@ -559,6 +582,7 @@ jQuery.fn = jQuery.prototype = { * @name not * @type jQuery * @param Element el An element to remove from the set + * @cat DOM/Traversing */ /** @@ -573,6 +597,7 @@ jQuery.fn = jQuery.prototype = { * @name not * @type jQuery * @param String expr An expression with which to remove matching elements + * @cat DOM/Traversing */ not: function(t) { return this.pushStack( t.constructor == String ? @@ -591,6 +616,7 @@ jQuery.fn = jQuery.prototype = { * @name add * @type jQuery * @param String expr An expression whose matched elements are added + * @cat DOM/Traversing */ /** @@ -604,6 +630,7 @@ jQuery.fn = jQuery.prototype = { * @name add * @type jQuery * @param Array els An array of Elements to add + * @cat jQuery */ /** @@ -617,6 +644,7 @@ jQuery.fn = jQuery.prototype = { * @name add * @type jQuery * @param Element el An Element to add + * @cat jQuery */ add: function(t) { return this.pushStack( jQuery.merge( this, t.constructor == String ? @@ -631,6 +659,7 @@ jQuery.fn = jQuery.prototype = { * @member jQuery * @param {String} expr The expression with which to filter * @type Boolean + * @cat jQuery */ is: function(expr) { return expr ? jQuery.filter(expr,this).r.length > 0 : this.length > 0; @@ -717,6 +746,7 @@ jQuery.fn = jQuery.prototype = { * @param Object obj The object to extend * @param Object prop The object that will be merged into the first. * @type Object + * @cat Javascript */ jQuery.extend = jQuery.fn.extend = function(obj,prop) { if ( !prop ) { prop = obj; obj = this; } @@ -793,6 +823,7 @@ jQuery.extend({ * @param Object obj The object, or array, to iterate over. * @param Object fn The function that will be executed on every object. * @type Object + * @cat Javascript */ each: function( obj, fn, args ) { if ( obj.length == undefined ) @@ -1476,6 +1507,7 @@ jQuery.macros = { * @name appendTo * @type jQuery * @param String expr A jQuery expression of elements to match. + * @cat DOM/Manipulation */ appendTo: "append", @@ -1492,6 +1524,7 @@ jQuery.macros = { * @name prependTo * @type jQuery * @param String expr A jQuery expression of elements to match. + * @cat DOM/Manipulation */ prependTo: "prepend", @@ -1508,6 +1541,7 @@ jQuery.macros = { * @name insertBefore * @type jQuery * @param String expr A jQuery expression of elements to match. + * @cat DOM/Manipulation */ insertBefore: "before", @@ -1524,6 +1558,7 @@ jQuery.macros = { * @name insertAfter * @type jQuery * @param String expr A jQuery expression of elements to match. + * @cat DOM/Manipulation */ insertAfter: "after" }, @@ -1537,6 +1572,7 @@ jQuery.macros = { * * @name width * @type String + * @cat CSS */ /** @@ -1551,6 +1587,7 @@ jQuery.macros = { * @name width * @type jQuery * @param String val Set the CSS property to the specified value. + * @cat CSS */ /** @@ -1562,6 +1599,7 @@ jQuery.macros = { * * @name height * @type String + * @cat CSS */ /** @@ -1576,6 +1614,7 @@ jQuery.macros = { * @name height * @type jQuery * @param String val Set the CSS property to the specified value. + * @cat CSS */ /** @@ -1587,6 +1626,7 @@ jQuery.macros = { * * @name top * @type String + * @cat CSS */ /** @@ -1601,6 +1641,7 @@ jQuery.macros = { * @name top * @type jQuery * @param String val Set the CSS property to the specified value. + * @cat CSS */ /** @@ -1612,6 +1653,7 @@ jQuery.macros = { * * @name left * @type String + * @cat CSS */ /** @@ -1626,6 +1668,7 @@ jQuery.macros = { * @name left * @type jQuery * @param String val Set the CSS property to the specified value. + * @cat CSS */ /** @@ -1637,6 +1680,7 @@ jQuery.macros = { * * @name position * @type String + * @cat CSS */ /** @@ -1649,6 +1693,7 @@ jQuery.macros = { * @name position * @type jQuery * @param String val Set the CSS property to the specified value. + * @cat CSS */ /** @@ -1660,6 +1705,7 @@ jQuery.macros = { * * @name float * @type String + * @cat CSS */ /** @@ -1672,6 +1718,7 @@ jQuery.macros = { * @name float * @type jQuery * @param String val Set the CSS property to the specified value. + * @cat CSS */ /** @@ -1683,6 +1730,7 @@ jQuery.macros = { * * @name overflow * @type String + * @cat CSS */ /** @@ -1695,6 +1743,7 @@ jQuery.macros = { * @name overflow * @type jQuery * @param String val Set the CSS property to the specified value. + * @cat CSS */ /** @@ -1706,6 +1755,7 @@ jQuery.macros = { * * @name color * @type String + * @cat CSS */ /** @@ -1718,6 +1768,7 @@ jQuery.macros = { * @name color * @type jQuery * @param String val Set the CSS property to the specified value. + * @cat CSS */ /** @@ -1729,6 +1780,7 @@ jQuery.macros = { * * @name background * @type String + * @cat CSS */ /** @@ -1741,6 +1793,7 @@ jQuery.macros = { * @name background * @type jQuery * @param String val Set the CSS property to the specified value. + * @cat CSS */ css: "width,height,top,left,position,float,overflow,color,background".split(","), @@ -1757,6 +1810,7 @@ jQuery.macros = { * * @name val * @type String + * @cat DOM/Attributes */ /** @@ -1769,6 +1823,7 @@ jQuery.macros = { * @name val * @type jQuery * @param String val Set the property to the specified value. + * @cat DOM/Attributes */ val: "value", @@ -1781,6 +1836,7 @@ jQuery.macros = { * * @name html * @type String + * @cat DOM/Attributes */ /** @@ -1788,11 +1844,12 @@ jQuery.macros = { * * @example $("div").html("new stuff"); * @before
- * @result
new stuff + * @result
new stuff
* * @name html * @type jQuery * @param String val Set the html contents to the specified value. + * @cat DOM/Attributes */ html: "innerHTML", @@ -1805,6 +1862,7 @@ jQuery.macros = { * * @name id * @type String + * @cat DOM/Attributes */ /** @@ -1817,6 +1875,7 @@ jQuery.macros = { * @name id * @type jQuery * @param String val Set the property to the specified value. + * @cat DOM/Attributes */ id: null, @@ -1829,6 +1888,7 @@ jQuery.macros = { * * @name title * @type String + * @cat DOM/Attributes */ /** @@ -1841,6 +1901,7 @@ jQuery.macros = { * @name title * @type jQuery * @param String val Set the property to the specified value. + * @cat DOM/Attributes */ title: null, @@ -1853,6 +1914,7 @@ jQuery.macros = { * * @name name * @type String + * @cat DOM/Attributes */ /** @@ -1865,6 +1927,7 @@ jQuery.macros = { * @name name * @type jQuery * @param String val Set the property to the specified value. + * @cat DOM/Attributes */ name: null, @@ -1877,6 +1940,7 @@ jQuery.macros = { * * @name href * @type String + * @cat DOM/Attributes */ /** @@ -1889,6 +1953,7 @@ jQuery.macros = { * @name href * @type jQuery * @param String val Set the property to the specified value. + * @cat DOM/Attributes */ href: null, @@ -1901,6 +1966,7 @@ jQuery.macros = { * * @name src * @type String + * @cat DOM/Attributes */ /** @@ -1913,6 +1979,7 @@ jQuery.macros = { * @name src * @type jQuery * @param String val Set the property to the specified value. + * @cat DOM/Attributes */ src: null, @@ -1925,6 +1992,7 @@ jQuery.macros = { * * @name rel * @type String + * @cat DOM/Attributes */ /** @@ -1937,6 +2005,7 @@ jQuery.macros = { * @name rel * @type jQuery * @param String val Set the property to the specified value. + * @cat DOM/Attributes */ rel: null }, @@ -1952,6 +2021,7 @@ jQuery.macros = { * * @name parent * @type jQuery + * @cat DOM/Traversing */ /** @@ -1965,6 +2035,7 @@ jQuery.macros = { * @name parent * @type jQuery * @param String expr An expression to filter the parents with + * @cat DOM/Traversing */ parent: "a.parentNode", @@ -1978,6 +2049,7 @@ jQuery.macros = { * * @name ancestors * @type jQuery + * @cat DOM/Traversing */ /** @@ -1991,6 +2063,7 @@ jQuery.macros = { * @name ancestors * @type jQuery * @param String expr An expression to filter the ancestors with + * @cat DOM/Traversing */ ancestors: jQuery.parents, @@ -2004,6 +2077,7 @@ jQuery.macros = { * * @name parents * @type jQuery + * @cat DOM/Traversing */ /** @@ -2017,6 +2091,7 @@ jQuery.macros = { * @name parents * @type jQuery * @param String expr An expression to filter the ancestors with + * @cat DOM/Traversing */ parents: jQuery.parents, @@ -2032,6 +2107,7 @@ jQuery.macros = { * * @name next * @type jQuery + * @cat DOM/Traversing */ /** @@ -2047,6 +2123,7 @@ jQuery.macros = { * @name next * @type jQuery * @param String expr An expression to filter the next Elements with + * @cat DOM/Traversing */ next: "jQuery.sibling(a).next", @@ -2062,6 +2139,7 @@ jQuery.macros = { * * @name prev * @type jQuery + * @cat DOM/Traversing */ /** @@ -2077,6 +2155,7 @@ jQuery.macros = { * @name prev * @type jQuery * @param String expr An expression to filter the previous Elements with + * @cat DOM/Traversing */ prev: "jQuery.sibling(a).prev", @@ -2090,6 +2169,7 @@ jQuery.macros = { * * @name siblings * @type jQuery + * @cat DOM/Traversing */ /** @@ -2103,6 +2183,7 @@ jQuery.macros = { * @name siblings * @type jQuery * @param String expr An expression to filter the sibling Elements with + * @cat DOM/Traversing */ siblings: jQuery.sibling, @@ -2117,10 +2198,11 @@ jQuery.macros = { * * @name children * @type jQuery + * @cat DOM/Traversing */ /** - * Get a set of elements containing all of the unique siblings of each of the + * Get a set of elements containing all of the unique children of each of the * matched set of elements, and filtered by an expression. * * @example $("div").children(".selected") @@ -2130,6 +2212,7 @@ jQuery.macros = { * @name children * @type jQuery * @param String expr An expression to filter the child Elements with + * @cat DOM/Traversing */ children: "a.childNodes" }, @@ -2144,6 +2227,7 @@ jQuery.macros = { * * @name show * @type jQuery + * @cat Effects */ _show: function(){ this.style.display = this.oldblock ? this.oldblock : ""; @@ -2160,6 +2244,7 @@ jQuery.macros = { * * @name hide * @type jQuery + * @cat Effects */ _hide: function(){ this.oldblock = this.oldblock || jQuery.css(this,"display"); @@ -2179,6 +2264,7 @@ jQuery.macros = { * * @name toggle * @type jQuery + * @cat Effects */ _toggle: function(){ var d = jQuery.css(this,"display"); @@ -2188,52 +2274,78 @@ jQuery.macros = { /** * Adds the specified class to each of the set of matched elements. * - * @example ("p").addClass("selected") + * @example $("p").addClass("selected") * @before

Hello

* @result [

Hello

] * * @name addClass * @type jQuery * @param String class A CSS class to add to the elements + * @cat DOM */ addClass: function(c){ jQuery.className.add(this,c); }, /** - * The opposite of addClass. Removes the specified class from the - * set of matched elements. + * Removes the specified class from the set of matched elements. * - * @example ("p").removeClass("selected") + * @example $("p").removeClass("selected") * @before

Hello

* @result [

Hello

] * * @name removeClass * @type jQuery * @param String class A CSS class to remove from the elements + * @cat DOM */ removeClass: function(c){ jQuery.className.remove(this,c); }, /** - * Adds the specified class if it is present. Remove it if it is + * Adds the specified class if it is present, removes it if it is * not present. * - * @example ("p").toggleClass("selected") + * @example $("p").toggleClass("selected") * @before

Hello

Hello Again

* @result [

Hello

,

Hello Again

] * * @name toggleClass * @type jQuery * @param String class A CSS class with which to toggle the elements + * @cat DOM */ toggleClass: function( c ){ jQuery.className[ jQuery.className.has(this,c) ? "remove" : "add" ](this,c); }, /** - * TODO: Document + * Removes all matched elements from the DOM. This does NOT remove them from the + * jQuery object, allowing you to use the matched elements further. + * + * @example $("p").remove(); + * @before

Hello

how are

you?

+ * @result how are + * + * @name remove + * @type jQuery + * @cat DOM/Manipulation + */ + + /** + * Removes only elements (out of the list of matched elements) that match + * the specified jQuery expression. This does NOT remove them from the + * jQuery object, allowing you to use the matched elements further. + * + * @example $("p").remove(".hello"); + * @before

Hello

how are

you?

+ * @result how are

you?

+ * + * @name remove + * @type jQuery + * @param String expr A jQuery expression to filter elements by. + * @cat DOM/Manipulation */ remove: function(a){ if ( !a || jQuery.filter( [this], a ).r ) @@ -2243,12 +2355,13 @@ jQuery.macros = { /** * Removes all child nodes from the set of matched elements. * - * @example ("p").empty() + * @example $("p").empty() * @before

Hello, Person and person

* @result [

] * * @name empty * @type jQuery + * @cat DOM/Manipulation */ empty: function(){ while ( this.firstChild ) @@ -2279,6 +2392,7 @@ jQuery.macros = { * @type jQuery * @param String type An event type * @param Function fn A function to bind to the event on each of the set of matched elements + * @cat Events */ bind: function( type, fn ) { if ( fn.constructor == String ) @@ -2299,6 +2413,7 @@ jQuery.macros = { * @type jQuery * @param String type An event type * @param Function fn A function to unbind from the event on each of the set of matched elements + * @cat Events */ /** @@ -2312,6 +2427,7 @@ jQuery.macros = { * @name unbind * @type jQuery * @param String type An event type + * @cat Events */ /** @@ -2323,6 +2439,7 @@ jQuery.macros = { * * @name unbind * @type jQuery + * @cat Events */ unbind: function( type, fn ) { jQuery.event.remove( this, type, fn ); @@ -2338,6 +2455,7 @@ jQuery.macros = { * @name trigger * @type jQuery * @param String type An event type to trigger. + * @cat Events */ trigger: function( type, data ) { jQuery.event.trigger( type, data, this );