From: John Resig Date: Fri, 1 Sep 2006 05:52:26 +0000 (+0000) Subject: Lots of documentation overhaul - much more documented, cat output works better now. X-Git-Url: http://git.asbjorn.biz/?p=jquery.git;a=commitdiff_plain;h=c8009abcce562198cbc3930ed11f74dd62eba531 Lots of documentation overhaul - much more documented, cat output works better now. --- diff --git a/build/docs/docs.js b/build/docs/docs.js index 6574f6b..a40f56a 100644 --- a/build/docs/docs.js +++ b/build/docs/docs.js @@ -23,6 +23,6 @@ function output( c, n ) { writeFile( dir + "/" + ( n == "docs" ? "index" : n ) + ".xml", "\n" + - "\n" + xml + "\n" + xml ); } diff --git a/build/docs/js/doc.js b/build/docs/js/doc.js index ec52b66..e5f7fcb 100644 --- a/build/docs/js/doc.js +++ b/build/docs/js/doc.js @@ -17,9 +17,11 @@ $(document).ready(function(){ }).ToolTipDemo('#fff'); $("a.name").click(function(){ - $("div.more,div.short",this.parentNode.parentNode).toggle('slow').find("div.desc",function(){ - $(this).html( $(this).html().replace(/\n\n/g, "

") ); - }); + $("div.more,div.short",this.parentNode.parentNode) + .find("div.desc",function(){ + $(this).html( $(this).html().replace(/\n\n/g, "

") ); + }) + .toggle('slow'); return false; }); diff --git a/build/docs/style/style.css b/build/docs/style/style.css index f76e87e..d64a601 100644 --- a/build/docs/style/style.css +++ b/build/docs/style/style.css @@ -116,7 +116,6 @@ ul#docs li div.more { } ul#docs li div.example { - overflow: auto; border-top: 1px solid #DDD; margin-top: 15px; } @@ -130,7 +129,6 @@ ul#docs li div.example pre { color: #000; background: #EEE; padding: 5px; - overflow: auto; font-size: 0.8em; } diff --git a/build/js/parse.js b/build/js/parse.js index c9454d1..498361d 100644 --- a/build/js/parse.js +++ b/build/js/parse.js @@ -69,7 +69,7 @@ function parse( f ) { } function categorize( json ) { - var obj = { methods: [] }; + var obj = { cat: [], method: [] }; for ( var i = 0; i < json.length; i++ ) { if ( !json[i].cat ) json[i].cat = ""; @@ -79,17 +79,26 @@ function categorize( json ) { var pos = obj; for ( var j = 0; j < cat.length; j++ ) { var c = cat[j]; + var curCat = null; + + // Locate current category + for ( var n = 0; n < pos.cat.length; n++ ) + if ( pos.cat[n].value == c ) + curCat = pos.cat[n]; // Create current category - if ( !pos[c] ) pos[c] = { methods: [] }; + if ( !curCat ) { + curCat = { value: c, cat: [], method: [] }; + pos.cat.push( curCat ) + } // If we're at the end, add the method if ( j == cat.length - 1 ) - pos[c].methods.push( json[i] ); + curCat.method.push( json[i] ); // Otherwise, traverse deeper else - pos = pos[c]; + pos = curCat; } } diff --git a/build/js/xml.js b/build/js/xml.js index b2b09c6..1d50558 100644 --- a/build/js/xml.js +++ b/build/js/xml.js @@ -9,15 +9,13 @@ Object.toXML = function( obj, tag ) { var p = "", child = ""; for ( var i in obj ) - if ( obj[i].constructor != String || /\n" + child + "\n" : "/>\n" ); - } else if ( obj.constructor == String ) { - //obj = obj.replace(/</g,"<").replace(/>/g,">"); - //return "<" + tag + ">"; + } else if ( obj.constructor == String || obj.constructor == Number ) { return "<" + tag + ">" + obj + "\n"; } diff --git a/src/event/event.js b/src/event/event.js index 051ba00..bbf52a9 100644 --- a/src/event/event.js +++ b/src/event/event.js @@ -153,71 +153,139 @@ jQuery.extend({ new function(){ /** - * Bind a function to the blur event of each matched element. + * Bind a function to the scroll event of each matched element. * - * @example $("p").blur( function() { alert("Hello"); } ); + * @example $("p").scroll( function() { alert("Hello"); } ); * @before

Hello

- * @result

Hello

+ * @result

Hello

* - * @name blur + * @name scroll * @type jQuery - * @param Function fn A function to bind to the blur event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the scroll event on each of the matched elements. + * @cat Events/Browser */ /** - * Trigger the blur event of each matched element. This causes all of the functions - * that have been bound to thet blur event to be executed. + * Trigger the scroll event of each matched element. This causes all of the functions + * that have been bound to thet scroll event to be executed. * - * @example $("p").blur(); - * @before

Hello

+ * @example $("p").scroll(); + * @before

Hello

* @result alert('Hello'); * - * @name blur + * @name scroll * @type jQuery - * @cat Events + * @cat Events/Browser */ /** - * Bind a function to the blur event of each matched element, which will only be executed once. - * Unlike a call to the normal .blur() method, calling .oneblur() causes the bound function to be + * Bind a function to the scroll event of each matched element, which will only be executed once. + * Unlike a call to the normal .scroll() method, calling .onescroll() causes the bound function to be * only executed the first time it is triggered, and never again (unless it is re-bound). * - * @example $("p").oneblur( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first blur + * @example $("p").onescroll( function() { alert("Hello"); } ); + * @before

Hello

+ * @result alert('Hello'); // Only executed for the first scroll * - * @name oneblur + * @name onescroll * @type jQuery - * @param Function fn A function to bind to the blur event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the scroll event on each of the matched elements. + * @cat Events/Browser */ /** - * Removes a bound blur event from each of the matched + * Removes a bound scroll event from each of the matched * elements. You must pass the identical function that was used in the original * bind method. * - * @example $("p").unblur( myFunction ); - * @before

Hello

+ * @example $("p").unscroll( myFunction ); + * @before

Hello

* @result

Hello

* - * @name unblur + * @name unscroll * @type jQuery - * @param Function fn A function to unbind from the blur event on each of the matched elements. - * @cat Events + * @param Function fn A function to unbind from the scroll event on each of the matched elements. + * @cat Events/Browser */ /** - * Removes all bound blur events from each of the matched elements. + * Removes all bound scroll events from each of the matched elements. * - * @example $("p").unblur(); - * @before

Hello

+ * @example $("p").unscroll(); + * @before

Hello

* @result

Hello

* - * @name unblur + * @name unscroll + * @type jQuery + * @cat Events/Browser + */ + + /** + * Bind a function to the submit event of each matched element. + * + * @example $("p").submit( function() { alert("Hello"); } ); + * @before

Hello

+ * @result

Hello

+ * + * @name submit + * @type jQuery + * @param Function fn A function to bind to the submit event on each of the matched elements. + * @cat Events/Form + */ + + /** + * Trigger the submit event of each matched element. This causes all of the functions + * that have been bound to thet submit event to be executed. + * + * @example $("p").submit(); + * @before

Hello

+ * @result alert('Hello'); + * + * @name submit + * @type jQuery + * @cat Events/Form + */ + + /** + * Bind a function to the submit event of each matched element, which will only be executed once. + * Unlike a call to the normal .submit() method, calling .onesubmit() causes the bound function to be + * only executed the first time it is triggered, and never again (unless it is re-bound). + * + * @example $("p").onesubmit( function() { alert("Hello"); } ); + * @before

Hello

+ * @result alert('Hello'); // Only executed for the first submit + * + * @name onesubmit + * @type jQuery + * @param Function fn A function to bind to the submit event on each of the matched elements. + * @cat Events/Form + */ + + /** + * Removes a bound submit event from each of the matched + * elements. You must pass the identical function that was used in the original + * bind method. + * + * @example $("p").unsubmit( myFunction ); + * @before

Hello

+ * @result

Hello

+ * + * @name unsubmit + * @type jQuery + * @param Function fn A function to unbind from the submit event on each of the matched elements. + * @cat Events/Form + */ + + /** + * Removes all bound submit events from each of the matched elements. + * + * @example $("p").unsubmit(); + * @before

Hello

+ * @result

Hello

+ * + * @name unsubmit * @type jQuery - * @cat Events + * @cat Events/Form */ /** @@ -230,7 +298,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 + * @cat Events/UI */ /** @@ -243,7 +311,7 @@ new function(){ * * @name focus * @type jQuery - * @cat Events + * @cat Events/UI */ /** @@ -258,7 +326,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 + * @cat Events/UI */ /** @@ -273,7 +341,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 + * @cat Events/UI */ /** @@ -285,483 +353,483 @@ new function(){ * * @name unfocus * @type jQuery - * @cat Events + * @cat Events/UI */ /** - * Bind a function to the load event of each matched element. + * Bind a function to the keydown event of each matched element. * - * @example $("p").load( function() { alert("Hello"); } ); + * @example $("p").keydown( function() { alert("Hello"); } ); * @before

Hello

- * @result

Hello

+ * @result

Hello

* - * @name load + * @name keydown * @type jQuery - * @param Function fn A function to bind to the load event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the keydown event on each of the matched elements. + * @cat Events/Keyboard */ /** - * Trigger the load event of each matched element. This causes all of the functions - * that have been bound to thet load event to be executed. + * Trigger the keydown event of each matched element. This causes all of the functions + * that have been bound to thet keydown event to be executed. * - * @example $("p").load(); - * @before

Hello

+ * @example $("p").keydown(); + * @before

Hello

* @result alert('Hello'); * - * @name load + * @name keydown * @type jQuery - * @cat Events + * @cat Events/Keyboard */ /** - * Bind a function to the load event of each matched element, which will only be executed once. - * Unlike a call to the normal .load() method, calling .oneload() causes the bound function to be + * Bind a function to the keydown event of each matched element, which will only be executed once. + * Unlike a call to the normal .keydown() method, calling .onekeydown() causes the bound function to be * only executed the first time it is triggered, and never again (unless it is re-bound). * - * @example $("p").oneload( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first load + * @example $("p").onekeydown( function() { alert("Hello"); } ); + * @before

Hello

+ * @result alert('Hello'); // Only executed for the first keydown * - * @name oneload + * @name onekeydown * @type jQuery - * @param Function fn A function to bind to the load event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the keydown event on each of the matched elements. + * @cat Events/Keyboard */ /** - * Removes a bound load event from each of the matched + * Removes a bound keydown event from each of the matched * elements. You must pass the identical function that was used in the original * bind method. * - * @example $("p").unload( myFunction ); - * @before

Hello

+ * @example $("p").unkeydown( myFunction ); + * @before

Hello

* @result

Hello

* - * @name unload + * @name unkeydown * @type jQuery - * @param Function fn A function to unbind from the load event on each of the matched elements. - * @cat Events + * @param Function fn A function to unbind from the keydown event on each of the matched elements. + * @cat Events/Keyboard */ /** - * Removes all bound load events from each of the matched elements. + * Removes all bound keydown events from each of the matched elements. * - * @example $("p").unload(); - * @before

Hello

+ * @example $("p").unkeydown(); + * @before

Hello

* @result

Hello

* - * @name unload + * @name unkeydown * @type jQuery - * @cat Events + * @cat Events/Keyboard */ /** - * Bind a function to the resize event of each matched element. + * Bind a function to the dblclick event of each matched element. * - * @example $("p").resize( function() { alert("Hello"); } ); + * @example $("p").dblclick( function() { alert("Hello"); } ); * @before

Hello

- * @result

Hello

+ * @result

Hello

* - * @name resize + * @name dblclick * @type jQuery - * @param Function fn A function to bind to the resize event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the dblclick event on each of the matched elements. + * @cat Events/Mouse */ /** - * Trigger the resize event of each matched element. This causes all of the functions - * that have been bound to thet resize event to be executed. + * Trigger the dblclick event of each matched element. This causes all of the functions + * that have been bound to thet dblclick event to be executed. * - * @example $("p").resize(); - * @before

Hello

+ * @example $("p").dblclick(); + * @before

Hello

* @result alert('Hello'); * - * @name resize + * @name dblclick * @type jQuery - * @cat Events + * @cat Events/Mouse */ /** - * Bind a function to the resize event of each matched element, which will only be executed once. - * Unlike a call to the normal .resize() method, calling .oneresize() causes the bound function to be + * Bind a function to the dblclick event of each matched element, which will only be executed once. + * Unlike a call to the normal .dblclick() method, calling .onedblclick() causes the bound function to be * only executed the first time it is triggered, and never again (unless it is re-bound). * - * @example $("p").oneresize( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first resize + * @example $("p").onedblclick( function() { alert("Hello"); } ); + * @before

Hello

+ * @result alert('Hello'); // Only executed for the first dblclick * - * @name oneresize + * @name onedblclick * @type jQuery - * @param Function fn A function to bind to the resize event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the dblclick event on each of the matched elements. + * @cat Events/Mouse */ /** - * Removes a bound resize event from each of the matched + * Removes a bound dblclick event from each of the matched * elements. You must pass the identical function that was used in the original * bind method. * - * @example $("p").unresize( myFunction ); - * @before

Hello

+ * @example $("p").undblclick( myFunction ); + * @before

Hello

* @result

Hello

* - * @name unresize + * @name undblclick * @type jQuery - * @param Function fn A function to unbind from the resize event on each of the matched elements. - * @cat Events + * @param Function fn A function to unbind from the dblclick event on each of the matched elements. + * @cat Events/Mouse */ /** - * Removes all bound resize events from each of the matched elements. + * Removes all bound dblclick events from each of the matched elements. * - * @example $("p").unresize(); - * @before

Hello

+ * @example $("p").undblclick(); + * @before

Hello

* @result

Hello

* - * @name unresize + * @name undblclick * @type jQuery - * @cat Events + * @cat Events/Mouse */ /** - * Bind a function to the scroll event of each matched element. + * Bind a function to the keypress event of each matched element. * - * @example $("p").scroll( function() { alert("Hello"); } ); + * @example $("p").keypress( function() { alert("Hello"); } ); * @before

Hello

- * @result

Hello

+ * @result

Hello

* - * @name scroll + * @name keypress * @type jQuery - * @param Function fn A function to bind to the scroll event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the keypress event on each of the matched elements. + * @cat Events/Keyboard */ /** - * Trigger the scroll event of each matched element. This causes all of the functions - * that have been bound to thet scroll event to be executed. + * Trigger the keypress event of each matched element. This causes all of the functions + * that have been bound to thet keypress event to be executed. * - * @example $("p").scroll(); - * @before

Hello

+ * @example $("p").keypress(); + * @before

Hello

* @result alert('Hello'); * - * @name scroll + * @name keypress * @type jQuery - * @cat Events + * @cat Events/Keyboard */ /** - * Bind a function to the scroll event of each matched element, which will only be executed once. - * Unlike a call to the normal .scroll() method, calling .onescroll() causes the bound function to be + * Bind a function to the keypress event of each matched element, which will only be executed once. + * Unlike a call to the normal .keypress() method, calling .onekeypress() causes the bound function to be * only executed the first time it is triggered, and never again (unless it is re-bound). * - * @example $("p").onescroll( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first scroll + * @example $("p").onekeypress( function() { alert("Hello"); } ); + * @before

Hello

+ * @result alert('Hello'); // Only executed for the first keypress * - * @name onescroll + * @name onekeypress * @type jQuery - * @param Function fn A function to bind to the scroll event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the keypress event on each of the matched elements. + * @cat Events/Keyboard */ /** - * Removes a bound scroll event from each of the matched + * Removes a bound keypress event from each of the matched * elements. You must pass the identical function that was used in the original * bind method. * - * @example $("p").unscroll( myFunction ); - * @before

Hello

+ * @example $("p").unkeypress( myFunction ); + * @before

Hello

* @result

Hello

* - * @name unscroll + * @name unkeypress * @type jQuery - * @param Function fn A function to unbind from the scroll event on each of the matched elements. - * @cat Events + * @param Function fn A function to unbind from the keypress event on each of the matched elements. + * @cat Events/Keyboard */ /** - * Removes all bound scroll events from each of the matched elements. + * Removes all bound keypress events from each of the matched elements. * - * @example $("p").unscroll(); - * @before

Hello

+ * @example $("p").unkeypress(); + * @before

Hello

* @result

Hello

* - * @name unscroll + * @name unkeypress * @type jQuery - * @cat Events + * @cat Events/Keyboard */ /** - * Bind a function to the unload event of each matched element. + * Bind a function to the error event of each matched element. * - * @example $("p").unload( function() { alert("Hello"); } ); + * @example $("p").error( function() { alert("Hello"); } ); * @before

Hello

- * @result

Hello

+ * @result

Hello

* - * @name unload + * @name error * @type jQuery - * @param Function fn A function to bind to the unload event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the error event on each of the matched elements. + * @cat Events/Browser */ /** - * Trigger the unload event of each matched element. This causes all of the functions - * that have been bound to thet unload event to be executed. + * Trigger the error event of each matched element. This causes all of the functions + * that have been bound to thet error event to be executed. * - * @example $("p").unload(); - * @before

Hello

+ * @example $("p").error(); + * @before

Hello

* @result alert('Hello'); * - * @name unload + * @name error * @type jQuery - * @cat Events + * @cat Events/Browser */ /** - * Bind a function to the unload event of each matched element, which will only be executed once. - * Unlike a call to the normal .unload() method, calling .oneunload() causes the bound function to be + * Bind a function to the error event of each matched element, which will only be executed once. + * Unlike a call to the normal .error() method, calling .oneerror() causes the bound function to be * only executed the first time it is triggered, and never again (unless it is re-bound). * - * @example $("p").oneunload( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first unload + * @example $("p").oneerror( function() { alert("Hello"); } ); + * @before

Hello

+ * @result alert('Hello'); // Only executed for the first error * - * @name oneunload + * @name oneerror * @type jQuery - * @param Function fn A function to bind to the unload event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the error event on each of the matched elements. + * @cat Events/Browser */ /** - * Removes a bound unload event from each of the matched + * Removes a bound error event from each of the matched * elements. You must pass the identical function that was used in the original * bind method. * - * @example $("p").ununload( myFunction ); - * @before

Hello

+ * @example $("p").unerror( myFunction ); + * @before

Hello

* @result

Hello

* - * @name ununload + * @name unerror * @type jQuery - * @param Function fn A function to unbind from the unload event on each of the matched elements. - * @cat Events + * @param Function fn A function to unbind from the error event on each of the matched elements. + * @cat Events/Browser */ /** - * Removes all bound unload events from each of the matched elements. + * Removes all bound error events from each of the matched elements. * - * @example $("p").ununload(); - * @before

Hello

+ * @example $("p").unerror(); + * @before

Hello

* @result

Hello

* - * @name ununload + * @name unerror * @type jQuery - * @cat Events + * @cat Events/Browser */ /** - * Bind a function to the click event of each matched element. + * Bind a function to the blur event of each matched element. * - * @example $("p").click( function() { alert("Hello"); } ); + * @example $("p").blur( function() { alert("Hello"); } ); * @before

Hello

- * @result

Hello

+ * @result

Hello

* - * @name click + * @name blur * @type jQuery - * @param Function fn A function to bind to the click event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the blur event on each of the matched elements. + * @cat Events/UI */ /** - * Trigger the click event of each matched element. This causes all of the functions - * that have been bound to thet click event to be executed. + * Trigger the blur event of each matched element. This causes all of the functions + * that have been bound to thet blur event to be executed. * - * @example $("p").click(); - * @before

Hello

+ * @example $("p").blur(); + * @before

Hello

* @result alert('Hello'); * - * @name click + * @name blur * @type jQuery - * @cat Events + * @cat Events/UI */ /** - * Bind a function to the click event of each matched element, which will only be executed once. - * Unlike a call to the normal .click() method, calling .oneclick() causes the bound function to be + * Bind a function to the blur event of each matched element, which will only be executed once. + * Unlike a call to the normal .blur() method, calling .oneblur() causes the bound function to be * only executed the first time it is triggered, and never again (unless it is re-bound). * - * @example $("p").oneclick( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first click + * @example $("p").oneblur( function() { alert("Hello"); } ); + * @before

Hello

+ * @result alert('Hello'); // Only executed for the first blur * - * @name oneclick + * @name oneblur * @type jQuery - * @param Function fn A function to bind to the click event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the blur event on each of the matched elements. + * @cat Events/UI */ /** - * Removes a bound click event from each of the matched + * Removes a bound blur event from each of the matched * elements. You must pass the identical function that was used in the original * bind method. * - * @example $("p").unclick( myFunction ); - * @before

Hello

+ * @example $("p").unblur( myFunction ); + * @before

Hello

* @result

Hello

* - * @name unclick + * @name unblur * @type jQuery - * @param Function fn A function to unbind from the click event on each of the matched elements. - * @cat Events + * @param Function fn A function to unbind from the blur event on each of the matched elements. + * @cat Events/UI */ /** - * Removes all bound click events from each of the matched elements. + * Removes all bound blur events from each of the matched elements. * - * @example $("p").unclick(); - * @before

Hello

+ * @example $("p").unblur(); + * @before

Hello

* @result

Hello

* - * @name unclick + * @name unblur * @type jQuery - * @cat Events + * @cat Events/UI */ /** - * Bind a function to the dblclick event of each matched element. + * Bind a function to the load event of each matched element. * - * @example $("p").dblclick( function() { alert("Hello"); } ); + * @example $("p").load( function() { alert("Hello"); } ); * @before

Hello

- * @result

Hello

+ * @result

Hello

* - * @name dblclick + * @name load * @type jQuery - * @param Function fn A function to bind to the dblclick event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the load event on each of the matched elements. + * @cat Events/Browser */ /** - * Trigger the dblclick event of each matched element. This causes all of the functions - * that have been bound to thet dblclick event to be executed. + * Trigger the load event of each matched element. This causes all of the functions + * that have been bound to thet load event to be executed. * - * @example $("p").dblclick(); - * @before

Hello

+ * @example $("p").load(); + * @before

Hello

* @result alert('Hello'); * - * @name dblclick + * @name load * @type jQuery - * @cat Events + * @cat Events/Browser */ /** - * Bind a function to the dblclick event of each matched element, which will only be executed once. - * Unlike a call to the normal .dblclick() method, calling .onedblclick() causes the bound function to be + * Bind a function to the load event of each matched element, which will only be executed once. + * Unlike a call to the normal .load() method, calling .oneload() causes the bound function to be * only executed the first time it is triggered, and never again (unless it is re-bound). * - * @example $("p").onedblclick( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first dblclick + * @example $("p").oneload( function() { alert("Hello"); } ); + * @before

Hello

+ * @result alert('Hello'); // Only executed for the first load * - * @name onedblclick + * @name oneload * @type jQuery - * @param Function fn A function to bind to the dblclick event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the load event on each of the matched elements. + * @cat Events/Browser */ /** - * Removes a bound dblclick event from each of the matched + * Removes a bound load event from each of the matched * elements. You must pass the identical function that was used in the original * bind method. * - * @example $("p").undblclick( myFunction ); - * @before

Hello

+ * @example $("p").unload( myFunction ); + * @before

Hello

* @result

Hello

* - * @name undblclick + * @name unload * @type jQuery - * @param Function fn A function to unbind from the dblclick event on each of the matched elements. - * @cat Events + * @param Function fn A function to unbind from the load event on each of the matched elements. + * @cat Events/Browser */ /** - * Removes all bound dblclick events from each of the matched elements. + * Removes all bound load events from each of the matched elements. * - * @example $("p").undblclick(); - * @before

Hello

+ * @example $("p").unload(); + * @before

Hello

* @result

Hello

* - * @name undblclick + * @name unload * @type jQuery - * @cat Events + * @cat Events/Browser */ /** - * Bind a function to the mousedown event of each matched element. + * Bind a function to the select event of each matched element. * - * @example $("p").mousedown( function() { alert("Hello"); } ); + * @example $("p").select( function() { alert("Hello"); } ); * @before

Hello

- * @result

Hello

+ * @result

Hello

* - * @name mousedown + * @name select * @type jQuery - * @param Function fn A function to bind to the mousedown event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the select event on each of the matched elements. + * @cat Events/Form */ /** - * Trigger the mousedown event of each matched element. This causes all of the functions - * that have been bound to thet mousedown event to be executed. + * Trigger the select event of each matched element. This causes all of the functions + * that have been bound to thet select event to be executed. * - * @example $("p").mousedown(); - * @before

Hello

+ * @example $("p").select(); + * @before

Hello

* @result alert('Hello'); * - * @name mousedown + * @name select * @type jQuery - * @cat Events + * @cat Events/Form */ /** - * Bind a function to the mousedown event of each matched element, which will only be executed once. - * Unlike a call to the normal .mousedown() method, calling .onemousedown() causes the bound function to be + * Bind a function to the select event of each matched element, which will only be executed once. + * Unlike a call to the normal .select() method, calling .oneselect() causes the bound function to be * only executed the first time it is triggered, and never again (unless it is re-bound). * - * @example $("p").onemousedown( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first mousedown + * @example $("p").oneselect( function() { alert("Hello"); } ); + * @before

Hello

+ * @result alert('Hello'); // Only executed for the first select * - * @name onemousedown + * @name oneselect * @type jQuery - * @param Function fn A function to bind to the mousedown event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the select event on each of the matched elements. + * @cat Events/Form */ /** - * Removes a bound mousedown event from each of the matched + * Removes a bound select event from each of the matched * elements. You must pass the identical function that was used in the original * bind method. * - * @example $("p").unmousedown( myFunction ); - * @before

Hello

+ * @example $("p").unselect( myFunction ); + * @before

Hello

* @result

Hello

* - * @name unmousedown + * @name unselect * @type jQuery - * @param Function fn A function to unbind from the mousedown event on each of the matched elements. - * @cat Events + * @param Function fn A function to unbind from the select event on each of the matched elements. + * @cat Events/Form */ /** - * Removes all bound mousedown events from each of the matched elements. + * Removes all bound select events from each of the matched elements. * - * @example $("p").unmousedown(); - * @before

Hello

+ * @example $("p").unselect(); + * @before

Hello

* @result

Hello

* - * @name unmousedown + * @name unselect * @type jQuery - * @cat Events + * @cat Events/Form */ /** @@ -774,7 +842,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 + * @cat Events/Mouse */ /** @@ -787,7 +855,7 @@ new function(){ * * @name mouseup * @type jQuery - * @cat Events + * @cat Events/Mouse */ /** @@ -802,7 +870,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 + * @cat Events/Mouse */ /** @@ -817,7 +885,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 + * @cat Events/Mouse */ /** @@ -829,211 +897,75 @@ new function(){ * * @name unmouseup * @type jQuery - * @cat Events + * @cat Events/Mouse */ /** - * Bind a function to the mousemove event of each matched element. + * Bind a function to the unload event of each matched element. * - * @example $("p").mousemove( function() { alert("Hello"); } ); + * @example $("p").unload( function() { alert("Hello"); } ); * @before

Hello

- * @result

Hello

+ * @result

Hello

* - * @name mousemove + * @name unload * @type jQuery - * @param Function fn A function to bind to the mousemove event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the unload event on each of the matched elements. + * @cat Events/Browser */ /** - * Trigger the mousemove event of each matched element. This causes all of the functions - * that have been bound to thet mousemove event to be executed. + * Trigger the unload event of each matched element. This causes all of the functions + * that have been bound to thet unload event to be executed. * - * @example $("p").mousemove(); - * @before

Hello

+ * @example $("p").unload(); + * @before

Hello

* @result alert('Hello'); * - * @name mousemove + * @name unload * @type jQuery - * @cat Events + * @cat Events/Browser */ /** - * Bind a function to the mousemove event of each matched element, which will only be executed once. - * Unlike a call to the normal .mousemove() method, calling .onemousemove() causes the bound function to be + * Bind a function to the unload event of each matched element, which will only be executed once. + * Unlike a call to the normal .unload() method, calling .oneunload() causes the bound function to be * only executed the first time it is triggered, and never again (unless it is re-bound). * - * @example $("p").onemousemove( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first mousemove + * @example $("p").oneunload( function() { alert("Hello"); } ); + * @before

Hello

+ * @result alert('Hello'); // Only executed for the first unload * - * @name onemousemove + * @name oneunload * @type jQuery - * @param Function fn A function to bind to the mousemove event on each of the matched elements. - * @cat Events - */ - - /** - * Removes a bound mousemove event from each of the matched - * elements. You must pass the identical function that was used in the original - * bind method. - * - * @example $("p").unmousemove( myFunction ); - * @before

Hello

- * @result

Hello

- * - * @name unmousemove - * @type jQuery - * @param Function fn A function to unbind from the mousemove event on each of the matched elements. - * @cat Events - */ - - /** - * Removes all bound mousemove events from each of the matched elements. - * - * @example $("p").unmousemove(); - * @before

Hello

- * @result

Hello

- * - * @name unmousemove - * @type jQuery - * @cat Events - */ - - /** - * Bind a function to the mouseover event of each matched element. - * - * @example $("p").mouseover( function() { alert("Hello"); } ); - * @before

Hello

- * @result

Hello

- * - * @name mouseover - * @type jQuery - * @param Function fn A function to bind to the mouseover event on each of the matched elements. - * @cat Events - */ - - /** - * Trigger the mouseover event of each matched element. This causes all of the functions - * that have been bound to thet mouseover event to be executed. - * - * @example $("p").mouseover(); - * @before

Hello

- * @result alert('Hello'); - * - * @name mouseover - * @type jQuery - * @cat Events - */ - - /** - * Bind a function to the mouseover event of each matched element, which will only be executed once. - * Unlike a call to the normal .mouseover() method, calling .onemouseover() causes the bound function to be - * only executed the first time it is triggered, and never again (unless it is re-bound). - * - * @example $("p").onemouseover( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first mouseover - * - * @name onemouseover - * @type jQuery - * @param Function fn A function to bind to the mouseover event on each of the matched elements. - * @cat Events - */ - - /** - * Removes a bound mouseover event from each of the matched - * elements. You must pass the identical function that was used in the original - * bind method. - * - * @example $("p").unmouseover( myFunction ); - * @before

Hello

- * @result

Hello

- * - * @name unmouseover - * @type jQuery - * @param Function fn A function to unbind from the mouseover event on each of the matched elements. - * @cat Events - */ - - /** - * Removes all bound mouseover events from each of the matched elements. - * - * @example $("p").unmouseover(); - * @before

Hello

- * @result

Hello

- * - * @name unmouseover - * @type jQuery - * @cat Events - */ - - /** - * Bind a function to the mouseout event of each matched element. - * - * @example $("p").mouseout( function() { alert("Hello"); } ); - * @before

Hello

- * @result

Hello

- * - * @name mouseout - * @type jQuery - * @param Function fn A function to bind to the mouseout event on each of the matched elements. - * @cat Events - */ - - /** - * Trigger the mouseout event of each matched element. This causes all of the functions - * that have been bound to thet mouseout event to be executed. - * - * @example $("p").mouseout(); - * @before

Hello

- * @result alert('Hello'); - * - * @name mouseout - * @type jQuery - * @cat Events - */ - - /** - * Bind a function to the mouseout event of each matched element, which will only be executed once. - * Unlike a call to the normal .mouseout() method, calling .onemouseout() causes the bound function to be - * only executed the first time it is triggered, and never again (unless it is re-bound). - * - * @example $("p").onemouseout( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first mouseout - * - * @name onemouseout - * @type jQuery - * @param Function fn A function to bind to the mouseout event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the unload event on each of the matched elements. + * @cat Events/Browser */ /** - * Removes a bound mouseout event from each of the matched + * Removes a bound unload event from each of the matched * elements. You must pass the identical function that was used in the original * bind method. * - * @example $("p").unmouseout( myFunction ); - * @before

Hello

+ * @example $("p").ununload( myFunction ); + * @before

Hello

* @result

Hello

* - * @name unmouseout + * @name ununload * @type jQuery - * @param Function fn A function to unbind from the mouseout event on each of the matched elements. - * @cat Events + * @param Function fn A function to unbind from the unload event on each of the matched elements. + * @cat Events/Browser */ /** - * Removes all bound mouseout events from each of the matched elements. + * Removes all bound unload events from each of the matched elements. * - * @example $("p").unmouseout(); - * @before

Hello

+ * @example $("p").ununload(); + * @before

Hello

* @result

Hello

* - * @name unmouseout + * @name ununload * @type jQuery - * @cat Events + * @cat Events/Browser */ /** @@ -1046,7 +978,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 + * @cat Events/Form */ /** @@ -1059,7 +991,7 @@ new function(){ * * @name change * @type jQuery - * @cat Events + * @cat Events/Form */ /** @@ -1074,7 +1006,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 + * @cat Events/Form */ /** @@ -1089,7 +1021,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 + * @cat Events/Form */ /** @@ -1101,483 +1033,415 @@ new function(){ * * @name unchange * @type jQuery - * @cat Events - */ - - /** - * Bind a function to the reset event of each matched element. - * - * @example $("p").reset( function() { alert("Hello"); } ); - * @before

Hello

- * @result

Hello

- * - * @name reset - * @type jQuery - * @param Function fn A function to bind to the reset event on each of the matched elements. - * @cat Events - */ - - /** - * Trigger the reset event of each matched element. This causes all of the functions - * that have been bound to thet reset event to be executed. - * - * @example $("p").reset(); - * @before

Hello

- * @result alert('Hello'); - * - * @name reset - * @type jQuery - * @cat Events - */ - - /** - * Bind a function to the reset event of each matched element, which will only be executed once. - * Unlike a call to the normal .reset() method, calling .onereset() causes the bound function to be - * only executed the first time it is triggered, and never again (unless it is re-bound). - * - * @example $("p").onereset( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first reset - * - * @name onereset - * @type jQuery - * @param Function fn A function to bind to the reset event on each of the matched elements. - * @cat Events + * @cat Events/Form */ /** - * Removes a bound reset event from each of the matched - * elements. You must pass the identical function that was used in the original - * bind method. - * - * @example $("p").unreset( myFunction ); - * @before

Hello

- * @result

Hello

- * - * @name unreset - * @type jQuery - * @param Function fn A function to unbind from the reset event on each of the matched elements. - * @cat Events - */ - - /** - * Removes all bound reset events from each of the matched elements. - * - * @example $("p").unreset(); - * @before

Hello

- * @result

Hello

- * - * @name unreset - * @type jQuery - * @cat Events - */ - - /** - * Bind a function to the select event of each matched element. + * Bind a function to the mouseout event of each matched element. * - * @example $("p").select( function() { alert("Hello"); } ); + * @example $("p").mouseout( function() { alert("Hello"); } ); * @before

Hello

- * @result

Hello

+ * @result

Hello

* - * @name select + * @name mouseout * @type jQuery - * @param Function fn A function to bind to the select event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the mouseout event on each of the matched elements. + * @cat Events/Mouse */ /** - * Trigger the select event of each matched element. This causes all of the functions - * that have been bound to thet select event to be executed. + * Trigger the mouseout event of each matched element. This causes all of the functions + * that have been bound to thet mouseout event to be executed. * - * @example $("p").select(); - * @before

Hello

+ * @example $("p").mouseout(); + * @before

Hello

* @result alert('Hello'); * - * @name select + * @name mouseout * @type jQuery - * @cat Events + * @cat Events/Mouse */ /** - * Bind a function to the select event of each matched element, which will only be executed once. - * Unlike a call to the normal .select() method, calling .oneselect() causes the bound function to be + * Bind a function to the mouseout event of each matched element, which will only be executed once. + * Unlike a call to the normal .mouseout() method, calling .onemouseout() causes the bound function to be * only executed the first time it is triggered, and never again (unless it is re-bound). * - * @example $("p").oneselect( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first select + * @example $("p").onemouseout( function() { alert("Hello"); } ); + * @before

Hello

+ * @result alert('Hello'); // Only executed for the first mouseout * - * @name oneselect + * @name onemouseout * @type jQuery - * @param Function fn A function to bind to the select event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the mouseout event on each of the matched elements. + * @cat Events/Mouse */ /** - * Removes a bound select event from each of the matched + * Removes a bound mouseout event from each of the matched * elements. You must pass the identical function that was used in the original * bind method. * - * @example $("p").unselect( myFunction ); - * @before

Hello

+ * @example $("p").unmouseout( myFunction ); + * @before

Hello

* @result

Hello

* - * @name unselect + * @name unmouseout * @type jQuery - * @param Function fn A function to unbind from the select event on each of the matched elements. - * @cat Events + * @param Function fn A function to unbind from the mouseout event on each of the matched elements. + * @cat Events/Mouse */ /** - * Removes all bound select events from each of the matched elements. + * Removes all bound mouseout events from each of the matched elements. * - * @example $("p").unselect(); - * @before

Hello

+ * @example $("p").unmouseout(); + * @before

Hello

* @result

Hello

* - * @name unselect + * @name unmouseout * @type jQuery - * @cat Events + * @cat Events/Mouse */ /** - * Bind a function to the submit event of each matched element. + * Bind a function to the keyup event of each matched element. * - * @example $("p").submit( function() { alert("Hello"); } ); + * @example $("p").keyup( function() { alert("Hello"); } ); * @before

Hello

- * @result

Hello

+ * @result

Hello

* - * @name submit + * @name keyup * @type jQuery - * @param Function fn A function to bind to the submit event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the keyup event on each of the matched elements. + * @cat Events/Keyboard */ /** - * Trigger the submit event of each matched element. This causes all of the functions - * that have been bound to thet submit event to be executed. + * Trigger the keyup event of each matched element. This causes all of the functions + * that have been bound to thet keyup event to be executed. * - * @example $("p").submit(); - * @before

Hello

+ * @example $("p").keyup(); + * @before

Hello

* @result alert('Hello'); * - * @name submit + * @name keyup * @type jQuery - * @cat Events + * @cat Events/Keyboard */ /** - * Bind a function to the submit event of each matched element, which will only be executed once. - * Unlike a call to the normal .submit() method, calling .onesubmit() causes the bound function to be + * Bind a function to the keyup event of each matched element, which will only be executed once. + * Unlike a call to the normal .keyup() method, calling .onekeyup() causes the bound function to be * only executed the first time it is triggered, and never again (unless it is re-bound). * - * @example $("p").onesubmit( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first submit + * @example $("p").onekeyup( function() { alert("Hello"); } ); + * @before

Hello

+ * @result alert('Hello'); // Only executed for the first keyup * - * @name onesubmit + * @name onekeyup * @type jQuery - * @param Function fn A function to bind to the submit event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the keyup event on each of the matched elements. + * @cat Events/Keyboard */ /** - * Removes a bound submit event from each of the matched + * Removes a bound keyup event from each of the matched * elements. You must pass the identical function that was used in the original * bind method. * - * @example $("p").unsubmit( myFunction ); - * @before

Hello

+ * @example $("p").unkeyup( myFunction ); + * @before

Hello

* @result

Hello

* - * @name unsubmit + * @name unkeyup * @type jQuery - * @param Function fn A function to unbind from the submit event on each of the matched elements. - * @cat Events + * @param Function fn A function to unbind from the keyup event on each of the matched elements. + * @cat Events/Keyboard */ /** - * Removes all bound submit events from each of the matched elements. + * Removes all bound keyup events from each of the matched elements. * - * @example $("p").unsubmit(); - * @before

Hello

+ * @example $("p").unkeyup(); + * @before

Hello

* @result

Hello

* - * @name unsubmit + * @name unkeyup * @type jQuery - * @cat Events + * @cat Events/Keyboard */ /** - * Bind a function to the keydown event of each matched element. + * Bind a function to the click event of each matched element. * - * @example $("p").keydown( function() { alert("Hello"); } ); + * @example $("p").click( function() { alert("Hello"); } ); * @before

Hello

- * @result

Hello

+ * @result

Hello

* - * @name keydown + * @name click * @type jQuery - * @param Function fn A function to bind to the keydown event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the click event on each of the matched elements. + * @cat Events/Mouse */ /** - * Trigger the keydown event of each matched element. This causes all of the functions - * that have been bound to thet keydown event to be executed. + * Trigger the click event of each matched element. This causes all of the functions + * that have been bound to thet click event to be executed. * - * @example $("p").keydown(); - * @before

Hello

+ * @example $("p").click(); + * @before

Hello

* @result alert('Hello'); * - * @name keydown + * @name click * @type jQuery - * @cat Events + * @cat Events/Mouse */ /** - * Bind a function to the keydown event of each matched element, which will only be executed once. - * Unlike a call to the normal .keydown() method, calling .onekeydown() causes the bound function to be + * Bind a function to the click event of each matched element, which will only be executed once. + * Unlike a call to the normal .click() method, calling .oneclick() causes the bound function to be * only executed the first time it is triggered, and never again (unless it is re-bound). * - * @example $("p").onekeydown( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first keydown + * @example $("p").oneclick( function() { alert("Hello"); } ); + * @before

Hello

+ * @result alert('Hello'); // Only executed for the first click * - * @name onekeydown + * @name oneclick * @type jQuery - * @param Function fn A function to bind to the keydown event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the click event on each of the matched elements. + * @cat Events/Mouse */ /** - * Removes a bound keydown event from each of the matched + * Removes a bound click event from each of the matched * elements. You must pass the identical function that was used in the original * bind method. * - * @example $("p").unkeydown( myFunction ); - * @before

Hello

+ * @example $("p").unclick( myFunction ); + * @before

Hello

* @result

Hello

* - * @name unkeydown + * @name unclick * @type jQuery - * @param Function fn A function to unbind from the keydown event on each of the matched elements. - * @cat Events + * @param Function fn A function to unbind from the click event on each of the matched elements. + * @cat Events/Mouse */ /** - * Removes all bound keydown events from each of the matched elements. + * Removes all bound click events from each of the matched elements. * - * @example $("p").unkeydown(); - * @before

Hello

+ * @example $("p").unclick(); + * @before

Hello

* @result

Hello

* - * @name unkeydown + * @name unclick * @type jQuery - * @cat Events + * @cat Events/Mouse */ /** - * Bind a function to the keypress event of each matched element. + * Bind a function to the resize event of each matched element. * - * @example $("p").keypress( function() { alert("Hello"); } ); + * @example $("p").resize( function() { alert("Hello"); } ); * @before

Hello

- * @result

Hello

+ * @result

Hello

* - * @name keypress + * @name resize * @type jQuery - * @param Function fn A function to bind to the keypress event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the resize event on each of the matched elements. + * @cat Events/Browser */ /** - * Trigger the keypress event of each matched element. This causes all of the functions - * that have been bound to thet keypress event to be executed. + * Trigger the resize event of each matched element. This causes all of the functions + * that have been bound to thet resize event to be executed. * - * @example $("p").keypress(); - * @before

Hello

+ * @example $("p").resize(); + * @before

Hello

* @result alert('Hello'); * - * @name keypress + * @name resize * @type jQuery - * @cat Events + * @cat Events/Browser */ /** - * Bind a function to the keypress event of each matched element, which will only be executed once. - * Unlike a call to the normal .keypress() method, calling .onekeypress() causes the bound function to be + * Bind a function to the resize event of each matched element, which will only be executed once. + * Unlike a call to the normal .resize() method, calling .oneresize() causes the bound function to be * only executed the first time it is triggered, and never again (unless it is re-bound). * - * @example $("p").onekeypress( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first keypress + * @example $("p").oneresize( function() { alert("Hello"); } ); + * @before

Hello

+ * @result alert('Hello'); // Only executed for the first resize * - * @name onekeypress + * @name oneresize * @type jQuery - * @param Function fn A function to bind to the keypress event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the resize event on each of the matched elements. + * @cat Events/Browser */ /** - * Removes a bound keypress event from each of the matched + * Removes a bound resize event from each of the matched * elements. You must pass the identical function that was used in the original * bind method. * - * @example $("p").unkeypress( myFunction ); - * @before

Hello

+ * @example $("p").unresize( myFunction ); + * @before

Hello

* @result

Hello

* - * @name unkeypress + * @name unresize * @type jQuery - * @param Function fn A function to unbind from the keypress event on each of the matched elements. - * @cat Events + * @param Function fn A function to unbind from the resize event on each of the matched elements. + * @cat Events/Browser */ /** - * Removes all bound keypress events from each of the matched elements. + * Removes all bound resize events from each of the matched elements. * - * @example $("p").unkeypress(); - * @before

Hello

+ * @example $("p").unresize(); + * @before

Hello

* @result

Hello

* - * @name unkeypress + * @name unresize * @type jQuery - * @cat Events + * @cat Events/Browser */ /** - * Bind a function to the keyup event of each matched element. + * Bind a function to the mousemove event of each matched element. * - * @example $("p").keyup( function() { alert("Hello"); } ); + * @example $("p").mousemove( function() { alert("Hello"); } ); * @before

Hello

- * @result

Hello

+ * @result

Hello

* - * @name keyup + * @name mousemove * @type jQuery - * @param Function fn A function to bind to the keyup event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the mousemove event on each of the matched elements. + * @cat Events/Mouse */ /** - * Trigger the keyup event of each matched element. This causes all of the functions - * that have been bound to thet keyup event to be executed. + * Trigger the mousemove event of each matched element. This causes all of the functions + * that have been bound to thet mousemove event to be executed. * - * @example $("p").keyup(); - * @before

Hello

+ * @example $("p").mousemove(); + * @before

Hello

* @result alert('Hello'); * - * @name keyup + * @name mousemove * @type jQuery - * @cat Events + * @cat Events/Mouse */ /** - * Bind a function to the keyup event of each matched element, which will only be executed once. - * Unlike a call to the normal .keyup() method, calling .onekeyup() causes the bound function to be + * Bind a function to the mousemove event of each matched element, which will only be executed once. + * Unlike a call to the normal .mousemove() method, calling .onemousemove() causes the bound function to be * only executed the first time it is triggered, and never again (unless it is re-bound). * - * @example $("p").onekeyup( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first keyup + * @example $("p").onemousemove( function() { alert("Hello"); } ); + * @before

Hello

+ * @result alert('Hello'); // Only executed for the first mousemove * - * @name onekeyup + * @name onemousemove * @type jQuery - * @param Function fn A function to bind to the keyup event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the mousemove event on each of the matched elements. + * @cat Events/Mouse */ /** - * Removes a bound keyup event from each of the matched + * Removes a bound mousemove event from each of the matched * elements. You must pass the identical function that was used in the original * bind method. * - * @example $("p").unkeyup( myFunction ); - * @before

Hello

+ * @example $("p").unmousemove( myFunction ); + * @before

Hello

* @result

Hello

* - * @name unkeyup + * @name unmousemove * @type jQuery - * @param Function fn A function to unbind from the keyup event on each of the matched elements. - * @cat Events + * @param Function fn A function to unbind from the mousemove event on each of the matched elements. + * @cat Events/Mouse */ /** - * Removes all bound keyup events from each of the matched elements. + * Removes all bound mousemove events from each of the matched elements. * - * @example $("p").unkeyup(); - * @before

Hello

+ * @example $("p").unmousemove(); + * @before

Hello

* @result

Hello

* - * @name unkeyup + * @name unmousemove * @type jQuery - * @cat Events + * @cat Events/Mouse */ /** - * Bind a function to the error event of each matched element. + * Bind a function to the mousedown event of each matched element. * - * @example $("p").error( function() { alert("Hello"); } ); + * @example $("p").mousedown( function() { alert("Hello"); } ); * @before

Hello

- * @result

Hello

+ * @result

Hello

* - * @name error + * @name mousedown * @type jQuery - * @param Function fn A function to bind to the error event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the mousedown event on each of the matched elements. + * @cat Events/Mouse */ /** - * Trigger the error event of each matched element. This causes all of the functions - * that have been bound to thet error event to be executed. + * Trigger the mousedown event of each matched element. This causes all of the functions + * that have been bound to thet mousedown event to be executed. * - * @example $("p").error(); - * @before

Hello

+ * @example $("p").mousedown(); + * @before

Hello

* @result alert('Hello'); * - * @name error + * @name mousedown * @type jQuery - * @cat Events + * @cat Events/Mouse */ /** - * Bind a function to the error event of each matched element, which will only be executed once. - * Unlike a call to the normal .error() method, calling .oneerror() causes the bound function to be + * Bind a function to the mousedown event of each matched element, which will only be executed once. + * Unlike a call to the normal .mousedown() method, calling .onemousedown() causes the bound function to be * only executed the first time it is triggered, and never again (unless it is re-bound). * - * @example $("p").oneerror( function() { alert("Hello"); } ); - * @before

Hello

- * @result alert('Hello'); // Only executed for the first error + * @example $("p").onemousedown( function() { alert("Hello"); } ); + * @before

Hello

+ * @result alert('Hello'); // Only executed for the first mousedown * - * @name oneerror + * @name onemousedown * @type jQuery - * @param Function fn A function to bind to the error event on each of the matched elements. - * @cat Events + * @param Function fn A function to bind to the mousedown event on each of the matched elements. + * @cat Events/Mouse */ /** - * Removes a bound error event from each of the matched + * Removes a bound mousedown event from each of the matched * elements. You must pass the identical function that was used in the original * bind method. * - * @example $("p").unerror( myFunction ); - * @before

Hello

+ * @example $("p").unmousedown( myFunction ); + * @before

Hello

* @result

Hello

* - * @name unerror + * @name unmousedown * @type jQuery - * @param Function fn A function to unbind from the error event on each of the matched elements. - * @cat Events + * @param Function fn A function to unbind from the mousedown event on each of the matched elements. + * @cat Events/Mouse */ /** - * Removes all bound error events from each of the matched elements. + * Removes all bound mousedown events from each of the matched elements. * - * @example $("p").unerror(); - * @before

Hello

+ * @example $("p").unmousedown(); + * @before

Hello

* @result

Hello

* - * @name unerror + * @name unmousedown * @type jQuery - * @cat Events + * @cat Events/Mouse */ var e = ("blur,focus,load,resize,scroll,unload,click,dblclick," + diff --git a/src/jquery/jquery.js b/src/jquery/jquery.js index c3975e3..467c074 100644 --- a/src/jquery/jquery.js +++ b/src/jquery/jquery.js @@ -26,6 +26,7 @@ window.undefined = window.undefined; * @constructor * @private * @name jQuery + * @cat Core */ function jQuery(a,c) { @@ -112,7 +113,7 @@ if ( typeof $ != "undefined" ) * * @name $ * @param String expr An expression to search with. - * @param DOMElement context A DOM Element, or Document, representing the base context. + * @param Element context A DOM Element, or Document, representing the base context. * @cat Core * @type jQuery */ @@ -131,7 +132,7 @@ if ( typeof $ != "undefined" ) * be manipulated. * * @name $ - * @param DOMElement elem A DOM element to be encapsulated by a jQuery object. + * @param Element elem A DOM element to be encapsulated by a jQuery object. * @cat Core * @type jQuery */ @@ -143,7 +144,7 @@ if ( typeof $ != "undefined" ) * @desc Hides all the input elements within a form * * @name $ - * @param Array elems An array of DOM elements to be encapsulated by a jQuery object. + * @param Array elems An array of DOM elements to be encapsulated by a jQuery object. * @cat Core * @type jQuery */ @@ -493,9 +494,10 @@ jQuery.fn = jQuery.prototype = { * stucture into a document, without ruining the original semantic * qualities of a document. * - * The way that is works is that it goes through the first element argument - * provided and finds the deepest element within the structure - it is that - * element that will en-wrap everything else. + * This works by going through the first element + * provided (which is generated, on the fly, from the provided HTML) + * and finds the deepest ancestor element within its + * structure - it is that element that will en-wrap everything else. * * @example $("p").wrap("
"); * @before

Test Paragraph.

@@ -503,10 +505,27 @@ jQuery.fn = jQuery.prototype = { * * @name wrap * @type jQuery - * @any String html A string of HTML, that will be created on the fly and wrapped around the target. - * @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. + * @param String html A string of HTML, that will be created on the fly and wrapped around the target. + * @cat DOM/Manipulation + */ + + /** + * Wrap all matched elements with a structure of other elements. + * This wrapping process is most useful for injecting additional + * stucture into a document, without ruining the original semantic + * qualities of a document. + * + * This works by going through the first element + * provided and finding the deepest ancestor element within its + * structure - it is that element that will en-wrap everything else. + * + * @example $("p").wrap("
"); + * @before

Test Paragraph.

+ * @result

Test Paragraph.

+ * + * @name wrap + * @type jQuery + * @param Element elem A DOM element that will be wrapped. * @cat DOM/Manipulation */ wrap: function() { @@ -531,7 +550,8 @@ jQuery.fn = jQuery.prototype = { }, /** - * Append any number of elements to the inside of all matched elements. + * Append any number of elements to the inside of every matched elements, + * generated from the provided HTML. * This operation is similar to doing an appendChild to all the * specified elements, adding them into the document. * @@ -541,10 +561,37 @@ jQuery.fn = jQuery.prototype = { * * @name append * @type jQuery - * @any String html A string of HTML, that will be created on the fly and appended to the target. - * @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. + * @param String html A string of HTML, that will be created on the fly and appended to the target. + * @cat DOM/Manipulation + */ + + /** + * Append an element to the inside of all matched elements. + * This operation is similar to doing an appendChild to all the + * specified elements, adding them into the document. + * + * @example $("p").append( $("#foo")[0] ); + * @before

I would like to say:

Hello + * @result

I would like to say: Hello

+ * + * @name append + * @type jQuery + * @param Element elem A DOM element that will be appended. + * @cat DOM/Manipulation + */ + + /** + * Append any number of elements to the inside of all matched elements. + * This operation is similar to doing an appendChild to all the + * specified elements, adding them into the document. + * + * @example $("p").append( $("b") ); + * @before

I would like to say:

Hello + * @result

I would like to say: Hello

+ * + * @name append + * @type jQuery + * @param Array elems An array of elements, all of which will be appended. * @cat DOM/Manipulation */ append: function() { @@ -554,20 +601,48 @@ jQuery.fn = jQuery.prototype = { }, /** - * Prepend any number of elements to the inside of all matched elements. + * Prepend any number of elements to the inside of every matched elements, + * generated from the provided HTML. + * This operation is the best way to insert dynamically created elements + * inside, at the beginning, of all the matched element. + * + * @example $("p").prepend("Hello"); + * @before

I would like to say:

+ * @result

HelloI would like to say:

+ * + * @name prepend + * @type jQuery + * @param String html A string of HTML, that will be created on the fly and appended to the target. + * @cat DOM/Manipulation + */ + + /** + * Append an element to the inside of all matched elements. + * This operation is the best way to insert an element inside, at the + * beginning, of all the matched element. + * + * @example $("p").prepend( $("#foo")[0] ); + * @before

I would like to say:

Hello + * @result

HelloI would like to say:

+ * + * @name prepend + * @type jQuery + * @param Element elem A DOM element that will be appended. + * @cat DOM/Manipulation + */ + + /** + * Append any number of elements to the inside of all matched elements. * This operation is the best way to insert a set of elements inside, at the * beginning, of all the matched element. * - * @example $("p").prepend("Hello"); - * @before

, how are you?

- * @result

Hello, how are you?

+ * @example $("p").prepend( $("b") ); + * @before

I would like to say:

Hello + * @result

HelloI would like to say:

* * @name prepend * @type jQuery - * @any String html A string of HTML, that will be created on the fly and prepended to the target. - * @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. + * @param Array elems An array of elements, all of which will be appended. * @cat DOM/Manipulation */ prepend: function() { @@ -577,18 +652,42 @@ jQuery.fn = jQuery.prototype = { }, /** - * Insert any number of elements before each of the matched elements. + * Insert any number of dynamically generated elements before each of the + * matched elements. * * @example $("p").before("Hello"); - * @before

how are you?

- * @result Hello

how are you?

+ * @before

I would like to say:

+ * @result Hello

I would like to say:

+ * + * @name before + * @type jQuery + * @param String html A string of HTML, that will be created on the fly and appended to the target. + * @cat DOM/Manipulation + */ + + /** + * Insert an element before each of the matched elements. + * + * @example $("p").before( $("#foo")[0] ); + * @before

I would like to say:

Hello + * @result Hello

I would like to say:

* * @name before * @type jQuery - * @any String html A string of HTML, that will be created on the fly and inserted. - * @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. + * @param Element elem A DOM element that will be appended. + * @cat DOM/Manipulation + */ + + /** + * Insert any number of elements before each of the matched elements. + * + * @example $("p").before( $("b") ); + * @before

I would like to say:

Hello + * @result Hello

I would like to say:

+ * + * @name before + * @type jQuery + * @param Array elems An array of elements, all of which will be appended. * @cat DOM/Manipulation */ before: function() { @@ -598,18 +697,42 @@ jQuery.fn = jQuery.prototype = { }, /** + * Insert any number of dynamically generated elements after each of the + * matched elements. + * + * @example $("p").after("Hello"); + * @before

I would like to say:

+ * @result

I would like to say:

Hello + * + * @name after + * @type jQuery + * @param String html A string of HTML, that will be created on the fly and appended to the target. + * @cat DOM/Manipulation + */ + + /** + * Insert an element after each of the matched elements. + * + * @example $("p").after( $("#foo")[0] ); + * @before Hello

I would like to say:

+ * @result

I would like to say:

Hello + * + * @name after + * @type jQuery + * @param Element elem A DOM element that will be appended. + * @cat DOM/Manipulation + */ + + /** * Insert any number of elements after each of the matched elements. * - * @example $("p").after("

I'm doing fine.

"); - * @before

How are you?

- * @result

How are you?

I'm doing fine.

+ * @example $("p").after( $("b") ); + * @before Hello

I would like to say:

+ * @result

I would like to say:

Hello * * @name after * @type jQuery - * @any String html A string of HTML, that will be created on the fly and inserted. - * @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. + * @param Array elems An array of elements, all of which will be appended. * @cat DOM/Manipulation */ after: function() { @@ -823,6 +946,7 @@ jQuery.fn = jQuery.prototype = { * @param Number int * @param Function fn The function doing the DOM manipulation. * @type jQuery + * @cat Core */ domManip: function(args, table, dir, fn){ var clone = this.size() > 1; @@ -856,6 +980,7 @@ jQuery.fn = jQuery.prototype = { * @param Array a * @param Array args * @type jQuery + * @cat Core */ pushStack: function(a,args) { var fn = args && args[args.length-1]; @@ -882,15 +1007,15 @@ jQuery.fn = jQuery.prototype = { * @private * @name extend * @param Object obj - * @param Object prop * @type Object + * @cat Core */ /** * Extend one object with another, returning the original, * modified, object. This is a great utility for simple inheritance. * - * @name jQuery.extend + * @name $.extend * @param Object obj The object to extend * @param Object prop The object that will be merged into the first. * @type Object @@ -907,6 +1032,7 @@ jQuery.extend({ * @private * @name init * @type undefined + * @cat Core */ init: function(){ jQuery.initDone = true; @@ -965,7 +1091,7 @@ jQuery.extend({ * A generic iterator function, which can be used to seemlessly * iterate over both objects and arrays. * - * @name jQuery.each + * @name $.each * @param Object obj The object, or array, to iterate over. * @param Object fn The function that will be executed on every object. * @type Object @@ -1264,8 +1390,10 @@ jQuery.extend({ * @test t( "Is Visible", "input:visible", ["text1","text2","radio1","radio2","check1","check2"] ); * @test t( "Is Hidden", "input:hidden", ["hidden1","hidden2"] ); * - * @name jQuery.find + * @name $.find + * @type Array * @private + * @cat Core */ find: function( t, context ) { // Make sure that the context is a DOM Element @@ -1466,10 +1594,10 @@ jQuery.extend({ /** * Remove the whitespace from the beginning and end of a string. * - * @private - * @name jQuery.trim + * @name $.trim * @type String * @param String str The string to trim. + * @cat Javascript */ trim: function(t){ return t.replace(/^\s+|\s+$/g, ""); @@ -1479,9 +1607,10 @@ jQuery.extend({ * All ancestors of a given element. * * @private - * @name jQuery.parents + * @name $.parents * @type Array * @param Element elem The element to find the ancestors of. + * @cat DOM/Traversing */ parents: function( elem ){ var matched = []; @@ -1497,9 +1626,10 @@ jQuery.extend({ * All elements on a specified axis. * * @private - * @name jQuery.sibling + * @name $.sibling * @type Array * @param Element elem The element to find all the siblings of (including itself). + * @cat DOM/Traversing */ sibling: function(elem, pos, not) { var elems = []; @@ -1525,11 +1655,11 @@ jQuery.extend({ /** * Merge two arrays together, removing all duplicates. * - * @private - * @name jQuery.merge + * @name $.merge * @type Array * @param Array a The first array to merge. * @param Array b The second array to merge. + * @cat Javascript */ merge: function(first, second) { var result = []; @@ -1562,12 +1692,12 @@ jQuery.extend({ * in to this method will be passed two arguments: 'a' (which is the * array item) and 'i' (which is the index of the item in the array). * - * @private - * @name jQuery.grep + * @name $.grep * @type Array * @param Array array The Array to find items in. * @param Function fn The function to process each item against. * @param Boolean inv Invert the selection - select the opposite of the function. + * @cat Javascript */ grep: function(elems, fn, inv) { // If a string is passed in for the function, make a function @@ -1594,11 +1724,11 @@ jQuery.extend({ * from the array. Both of these changes imply that the size of the array may not * be the same size upon completion, as it was when it started. * - * @private - * @name jQuery.map + * @name $.map * @type Array * @param Array array The Array to translate. * @param Function fn The function to process each item against. + * @cat Javascript */ map: function(elems, fn) { // If a string is passed in for the function, make a function