Commit c8009abc authored by John Resig's avatar John Resig

Lots of documentation overhaul - much more documented, cat output works better now.

parent 805d21c2
...@@ -23,6 +23,6 @@ function output( c, n ) { ...@@ -23,6 +23,6 @@ function output( c, n ) {
writeFile( dir + "/" + ( n == "docs" ? "index" : n ) + ".xml", writeFile( dir + "/" + ( n == "docs" ? "index" : n ) + ".xml",
"<?xml version='1.0' encoding='ISO-8859-1'?>\n" + "<?xml version='1.0' encoding='ISO-8859-1'?>\n" +
"<?xml-stylesheet type='text/xsl' href='style/docs.xsl'?>\n" + xml "<?xml-stylesheet type='text/xsl' href='style/" + n + ".xsl'?>\n" + xml
); );
} }
...@@ -17,9 +17,11 @@ $(document).ready(function(){ ...@@ -17,9 +17,11 @@ $(document).ready(function(){
}).ToolTipDemo('#fff'); }).ToolTipDemo('#fff');
$("a.name").click(function(){ $("a.name").click(function(){
$("div.more,div.short",this.parentNode.parentNode).toggle('slow').find("div.desc",function(){ $("div.more,div.short",this.parentNode.parentNode)
$(this).html( $(this).html().replace(/\n\n/g, "<br/><br/>") ); .find("div.desc",function(){
}); $(this).html( $(this).html().replace(/\n\n/g, "<br/><br/>") );
})
.toggle('slow');
return false; return false;
}); });
......
...@@ -116,7 +116,6 @@ ul#docs li div.more { ...@@ -116,7 +116,6 @@ ul#docs li div.more {
} }
ul#docs li div.example { ul#docs li div.example {
overflow: auto;
border-top: 1px solid #DDD; border-top: 1px solid #DDD;
margin-top: 15px; margin-top: 15px;
} }
...@@ -130,7 +129,6 @@ ul#docs li div.example pre { ...@@ -130,7 +129,6 @@ ul#docs li div.example pre {
color: #000; color: #000;
background: #EEE; background: #EEE;
padding: 5px; padding: 5px;
overflow: auto;
font-size: 0.8em; font-size: 0.8em;
} }
......
...@@ -69,7 +69,7 @@ function parse( f ) { ...@@ -69,7 +69,7 @@ function parse( f ) {
} }
function categorize( json ) { function categorize( json ) {
var obj = { methods: [] }; var obj = { cat: [], method: [] };
for ( var i = 0; i < json.length; i++ ) { for ( var i = 0; i < json.length; i++ ) {
if ( !json[i].cat ) json[i].cat = ""; if ( !json[i].cat ) json[i].cat = "";
...@@ -79,17 +79,26 @@ function categorize( json ) { ...@@ -79,17 +79,26 @@ function categorize( json ) {
var pos = obj; var pos = obj;
for ( var j = 0; j < cat.length; j++ ) { for ( var j = 0; j < cat.length; j++ ) {
var c = cat[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 // 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 we're at the end, add the method
if ( j == cat.length - 1 ) if ( j == cat.length - 1 )
pos[c].methods.push( json[i] ); curCat.method.push( json[i] );
// Otherwise, traverse deeper // Otherwise, traverse deeper
else else
pos = pos[c]; pos = curCat;
} }
} }
......
...@@ -9,15 +9,13 @@ Object.toXML = function( obj, tag ) { ...@@ -9,15 +9,13 @@ Object.toXML = function( obj, tag ) {
var p = "", child = ""; var p = "", child = "";
for ( var i in obj ) for ( var i in obj )
if ( obj[i].constructor != String || /</.test(obj[i] + "") || Object.toXML.force[i] ) if ( ( obj[i].constructor != String && obj[i].constructor != Number ) || /</.test(obj[i] + "") || Object.toXML.force[i] )
child += Object.toXML( obj[i], i ); child += Object.toXML( obj[i], i );
else else
p += " " + i + "='" + (obj[i] + "").replace(/'/g, "&apos;") + "'"; p += " " + i + "='" + (obj[i] + "").replace(/'/g, "&apos;") + "'";
return "<" + tag + p + ( child ? ">\n" + child + "</" + tag + ">\n" : "/>\n" ); return "<" + tag + p + ( child ? ">\n" + child + "</" + tag + ">\n" : "/>\n" );
} else if ( obj.constructor == String ) { } else if ( obj.constructor == String || obj.constructor == Number ) {
//obj = obj.replace(/&lt;/g,"<").replace(/&gt;/g,">");
//return "<" + tag + "><![CDATA[" + obj + "]]></" + tag + ">";
return "<" + tag + ">" + obj + "</" + tag + ">\n"; return "<" + tag + ">" + obj + "</" + tag + ">\n";
} }
......
...@@ -153,71 +153,139 @@ jQuery.extend({ ...@@ -153,71 +153,139 @@ jQuery.extend({
new function(){ 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 <p>Hello</p> * @before <p>Hello</p>
* @result <p onblur="alert('Hello');">Hello</p> * @result <p onscroll="alert('Hello');">Hello</p>
* *
* @name blur * @name scroll
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the blur event on each of the matched elements. * @param Function fn A function to bind to the scroll event on each of the matched elements.
* @cat Events * @cat Events/Browser
*/ */
/** /**
* Trigger the blur event of each matched element. This causes all of the functions * Trigger the scroll event of each matched element. This causes all of the functions
* that have been bound to thet blur event to be executed. * that have been bound to thet scroll event to be executed.
* *
* @example $("p").blur(); * @example $("p").scroll();
* @before <p onblur="alert('Hello');">Hello</p> * @before <p onscroll="alert('Hello');">Hello</p>
* @result alert('Hello'); * @result alert('Hello');
* *
* @name blur * @name scroll
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Browser
*/ */
/** /**
* Bind a function to the blur event of each matched element, which will only be executed once. * Bind a function to the scroll 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 * 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). * only executed the first time it is triggered, and never again (unless it is re-bound).
* *
* @example $("p").oneblur( function() { alert("Hello"); } ); * @example $("p").onescroll( function() { alert("Hello"); } );
* @before <p onblur="alert('Hello');">Hello</p> * @before <p onscroll="alert('Hello');">Hello</p>
* @result alert('Hello'); // Only executed for the first blur * @result alert('Hello'); // Only executed for the first scroll
* *
* @name oneblur * @name onescroll
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the blur event on each of the matched elements. * @param Function fn A function to bind to the scroll event on each of the matched elements.
* @cat Events * @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 * elements. You must pass the identical function that was used in the original
* bind method. * bind method.
* *
* @example $("p").unblur( myFunction ); * @example $("p").unscroll( myFunction );
* @before <p onblur="myFunction">Hello</p> * @before <p onscroll="myFunction">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unblur * @name unscroll
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the blur event on each of the matched elements. * @param Function fn A function to unbind from the scroll event on each of the matched elements.
* @cat Events * @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(); * @example $("p").unscroll();
* @before <p onblur="alert('Hello');">Hello</p> * @before <p onscroll="alert('Hello');">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @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 <p>Hello</p>
* @result <p onsubmit="alert('Hello');">Hello</p>
*
* @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 <p onsubmit="alert('Hello');">Hello</p>
* @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 <p onsubmit="alert('Hello');">Hello</p>
* @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 <p onsubmit="myFunction">Hello</p>
* @result <p>Hello</p>
*
* @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 <p onsubmit="alert('Hello');">Hello</p>
* @result <p>Hello</p>
*
* @name unsubmit
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Form
*/ */
/** /**
...@@ -230,7 +298,7 @@ new function(){ ...@@ -230,7 +298,7 @@ new function(){
* @name focus * @name focus
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the focus event on each of the matched elements. * @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(){ ...@@ -243,7 +311,7 @@ new function(){
* *
* @name focus * @name focus
* @type jQuery * @type jQuery
* @cat Events * @cat Events/UI
*/ */
/** /**
...@@ -258,7 +326,7 @@ new function(){ ...@@ -258,7 +326,7 @@ new function(){
* @name onefocus * @name onefocus
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the focus event on each of the matched elements. * @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(){ ...@@ -273,7 +341,7 @@ new function(){
* @name unfocus * @name unfocus
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the focus event on each of the matched elements. * @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(){ ...@@ -285,483 +353,483 @@ new function(){
* *
* @name unfocus * @name unfocus
* @type jQuery * @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 <p>Hello</p> * @before <p>Hello</p>
* @result <p onload="alert('Hello');">Hello</p> * @result <p onkeydown="alert('Hello');">Hello</p>
* *
* @name load * @name keydown
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the load event on each of the matched elements. * @param Function fn A function to bind to the keydown event on each of the matched elements.
* @cat Events * @cat Events/Keyboard
*/ */
/** /**
* Trigger the load event of each matched element. This causes all of the functions * Trigger the keydown event of each matched element. This causes all of the functions
* that have been bound to thet load event to be executed. * that have been bound to thet keydown event to be executed.
* *
* @example $("p").load(); * @example $("p").keydown();
* @before <p onload="alert('Hello');">Hello</p> * @before <p onkeydown="alert('Hello');">Hello</p>
* @result alert('Hello'); * @result alert('Hello');
* *
* @name load * @name keydown
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Keyboard
*/ */
/** /**
* Bind a function to the load event of each matched element, which will only be executed once. * Bind a function to the keydown 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 * 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). * only executed the first time it is triggered, and never again (unless it is re-bound).
* *
* @example $("p").oneload( function() { alert("Hello"); } ); * @example $("p").onekeydown( function() { alert("Hello"); } );
* @before <p onload="alert('Hello');">Hello</p> * @before <p onkeydown="alert('Hello');">Hello</p>
* @result alert('Hello'); // Only executed for the first load * @result alert('Hello'); // Only executed for the first keydown
* *
* @name oneload * @name onekeydown
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the load event on each of the matched elements. * @param Function fn A function to bind to the keydown event on each of the matched elements.
* @cat Events * @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 * elements. You must pass the identical function that was used in the original
* bind method. * bind method.
* *
* @example $("p").unload( myFunction ); * @example $("p").unkeydown( myFunction );
* @before <p onload="myFunction">Hello</p> * @before <p onkeydown="myFunction">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unload * @name unkeydown
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the load event on each of the matched elements. * @param Function fn A function to unbind from the keydown event on each of the matched elements.
* @cat Events * @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(); * @example $("p").unkeydown();
* @before <p onload="alert('Hello');">Hello</p> * @before <p onkeydown="alert('Hello');">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unload * @name unkeydown
* @type jQuery * @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 <p>Hello</p> * @before <p>Hello</p>
* @result <p onresize="alert('Hello');">Hello</p> * @result <p ondblclick="alert('Hello');">Hello</p>
* *
* @name resize * @name dblclick
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the resize event on each of the matched elements. * @param Function fn A function to bind to the dblclick event on each of the matched elements.
* @cat Events * @cat Events/Mouse
*/ */
/** /**
* Trigger the resize event of each matched element. This causes all of the functions * Trigger the dblclick event of each matched element. This causes all of the functions
* that have been bound to thet resize event to be executed. * that have been bound to thet dblclick event to be executed.
* *
* @example $("p").resize(); * @example $("p").dblclick();
* @before <p onresize="alert('Hello');">Hello</p> * @before <p ondblclick="alert('Hello');">Hello</p>
* @result alert('Hello'); * @result alert('Hello');
* *
* @name resize * @name dblclick
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Mouse
*/ */
/** /**
* Bind a function to the resize event of each matched element, which will only be executed once. * Bind a function to the dblclick 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 * 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). * only executed the first time it is triggered, and never again (unless it is re-bound).
* *
* @example $("p").oneresize( function() { alert("Hello"); } ); * @example $("p").onedblclick( function() { alert("Hello"); } );
* @before <p onresize="alert('Hello');">Hello</p> * @before <p ondblclick="alert('Hello');">Hello</p>
* @result alert('Hello'); // Only executed for the first resize * @result alert('Hello'); // Only executed for the first dblclick
* *
* @name oneresize * @name onedblclick
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the resize event on each of the matched elements. * @param Function fn A function to bind to the dblclick event on each of the matched elements.
* @cat Events * @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 * elements. You must pass the identical function that was used in the original
* bind method. * bind method.
* *
* @example $("p").unresize( myFunction ); * @example $("p").undblclick( myFunction );
* @before <p onresize="myFunction">Hello</p> * @before <p ondblclick="myFunction">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unresize * @name undblclick
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the resize event on each of the matched elements. * @param Function fn A function to unbind from the dblclick event on each of the matched elements.
* @cat Events * @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(); * @example $("p").undblclick();
* @before <p onresize="alert('Hello');">Hello</p> * @before <p ondblclick="alert('Hello');">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unresize * @name undblclick
* @type jQuery * @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 <p>Hello</p> * @before <p>Hello</p>
* @result <p onscroll="alert('Hello');">Hello</p> * @result <p onkeypress="alert('Hello');">Hello</p>
* *
* @name scroll * @name keypress
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the scroll event on each of the matched elements. * @param Function fn A function to bind to the keypress event on each of the matched elements.
* @cat Events * @cat Events/Keyboard
*/ */
/** /**
* Trigger the scroll event of each matched element. This causes all of the functions * Trigger the keypress event of each matched element. This causes all of the functions
* that have been bound to thet scroll event to be executed. * that have been bound to thet keypress event to be executed.
* *
* @example $("p").scroll(); * @example $("p").keypress();
* @before <p onscroll="alert('Hello');">Hello</p> * @before <p onkeypress="alert('Hello');">Hello</p>
* @result alert('Hello'); * @result alert('Hello');
* *
* @name scroll * @name keypress
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Keyboard
*/ */
/** /**
* Bind a function to the scroll event of each matched element, which will only be executed once. * Bind a function to the keypress 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 * 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). * only executed the first time it is triggered, and never again (unless it is re-bound).
* *
* @example $("p").onescroll( function() { alert("Hello"); } ); * @example $("p").onekeypress( function() { alert("Hello"); } );
* @before <p onscroll="alert('Hello');">Hello</p> * @before <p onkeypress="alert('Hello');">Hello</p>
* @result alert('Hello'); // Only executed for the first scroll * @result alert('Hello'); // Only executed for the first keypress
* *
* @name onescroll * @name onekeypress
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the scroll event on each of the matched elements. * @param Function fn A function to bind to the keypress event on each of the matched elements.
* @cat Events * @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 * elements. You must pass the identical function that was used in the original
* bind method. * bind method.
* *
* @example $("p").unscroll( myFunction ); * @example $("p").unkeypress( myFunction );
* @before <p onscroll="myFunction">Hello</p> * @before <p onkeypress="myFunction">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unscroll * @name unkeypress
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the scroll event on each of the matched elements. * @param Function fn A function to unbind from the keypress event on each of the matched elements.
* @cat Events * @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(); * @example $("p").unkeypress();
* @before <p onscroll="alert('Hello');">Hello</p> * @before <p onkeypress="alert('Hello');">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unscroll * @name unkeypress
* @type jQuery * @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 <p>Hello</p> * @before <p>Hello</p>
* @result <p onunload="alert('Hello');">Hello</p> * @result <p onerror="alert('Hello');">Hello</p>
* *
* @name unload * @name error
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the unload event on each of the matched elements. * @param Function fn A function to bind to the error event on each of the matched elements.
* @cat Events * @cat Events/Browser
*/ */
/** /**
* Trigger the unload event of each matched element. This causes all of the functions * Trigger the error event of each matched element. This causes all of the functions
* that have been bound to thet unload event to be executed. * that have been bound to thet error event to be executed.
* *
* @example $("p").unload(); * @example $("p").error();
* @before <p onunload="alert('Hello');">Hello</p> * @before <p onerror="alert('Hello');">Hello</p>
* @result alert('Hello'); * @result alert('Hello');
* *
* @name unload * @name error
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Browser
*/ */
/** /**
* Bind a function to the unload event of each matched element, which will only be executed once. * Bind a function to the error 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 * 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). * only executed the first time it is triggered, and never again (unless it is re-bound).
* *
* @example $("p").oneunload( function() { alert("Hello"); } ); * @example $("p").oneerror( function() { alert("Hello"); } );
* @before <p onunload="alert('Hello');">Hello</p> * @before <p onerror="alert('Hello');">Hello</p>
* @result alert('Hello'); // Only executed for the first unload * @result alert('Hello'); // Only executed for the first error
* *
* @name oneunload * @name oneerror
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the unload event on each of the matched elements. * @param Function fn A function to bind to the error event on each of the matched elements.
* @cat Events * @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 * elements. You must pass the identical function that was used in the original
* bind method. * bind method.
* *
* @example $("p").ununload( myFunction ); * @example $("p").unerror( myFunction );
* @before <p onunload="myFunction">Hello</p> * @before <p onerror="myFunction">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name ununload * @name unerror
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the unload event on each of the matched elements. * @param Function fn A function to unbind from the error event on each of the matched elements.
* @cat Events * @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(); * @example $("p").unerror();
* @before <p onunload="alert('Hello');">Hello</p> * @before <p onerror="alert('Hello');">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name ununload * @name unerror
* @type jQuery * @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 <p>Hello</p> * @before <p>Hello</p>
* @result <p onclick="alert('Hello');">Hello</p> * @result <p onblur="alert('Hello');">Hello</p>
* *
* @name click * @name blur
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the click event on each of the matched elements. * @param Function fn A function to bind to the blur event on each of the matched elements.
* @cat Events * @cat Events/UI
*/ */
/** /**
* Trigger the click event of each matched element. This causes all of the functions * Trigger the blur event of each matched element. This causes all of the functions
* that have been bound to thet click event to be executed. * that have been bound to thet blur event to be executed.
* *
* @example $("p").click(); * @example $("p").blur();
* @before <p onclick="alert('Hello');">Hello</p> * @before <p onblur="alert('Hello');">Hello</p>
* @result alert('Hello'); * @result alert('Hello');
* *
* @name click * @name blur
* @type jQuery * @type jQuery
* @cat Events * @cat Events/UI
*/ */
/** /**
* Bind a function to the click event of each matched element, which will only be executed once. * Bind a function to the blur 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 * 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). * only executed the first time it is triggered, and never again (unless it is re-bound).
* *
* @example $("p").oneclick( function() { alert("Hello"); } ); * @example $("p").oneblur( function() { alert("Hello"); } );
* @before <p onclick="alert('Hello');">Hello</p> * @before <p onblur="alert('Hello');">Hello</p>
* @result alert('Hello'); // Only executed for the first click * @result alert('Hello'); // Only executed for the first blur
* *
* @name oneclick * @name oneblur
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the click event on each of the matched elements. * @param Function fn A function to bind to the blur event on each of the matched elements.
* @cat Events * @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 * elements. You must pass the identical function that was used in the original
* bind method. * bind method.
* *
* @example $("p").unclick( myFunction ); * @example $("p").unblur( myFunction );
* @before <p onclick="myFunction">Hello</p> * @before <p onblur="myFunction">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unclick * @name unblur
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the click event on each of the matched elements. * @param Function fn A function to unbind from the blur event on each of the matched elements.
* @cat Events * @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(); * @example $("p").unblur();
* @before <p onclick="alert('Hello');">Hello</p> * @before <p onblur="alert('Hello');">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unclick * @name unblur
* @type jQuery * @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 <p>Hello</p> * @before <p>Hello</p>
* @result <p ondblclick="alert('Hello');">Hello</p> * @result <p onload="alert('Hello');">Hello</p>
* *
* @name dblclick * @name load
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the dblclick event on each of the matched elements. * @param Function fn A function to bind to the load event on each of the matched elements.
* @cat Events * @cat Events/Browser
*/ */
/** /**
* Trigger the dblclick event of each matched element. This causes all of the functions * Trigger the load event of each matched element. This causes all of the functions
* that have been bound to thet dblclick event to be executed. * that have been bound to thet load event to be executed.
* *
* @example $("p").dblclick(); * @example $("p").load();
* @before <p ondblclick="alert('Hello');">Hello</p> * @before <p onload="alert('Hello');">Hello</p>
* @result alert('Hello'); * @result alert('Hello');
* *
* @name dblclick * @name load
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Browser
*/ */
/** /**
* Bind a function to the dblclick event of each matched element, which will only be executed once. * Bind a function to the load 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 * 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). * only executed the first time it is triggered, and never again (unless it is re-bound).
* *
* @example $("p").onedblclick( function() { alert("Hello"); } ); * @example $("p").oneload( function() { alert("Hello"); } );
* @before <p ondblclick="alert('Hello');">Hello</p> * @before <p onload="alert('Hello');">Hello</p>
* @result alert('Hello'); // Only executed for the first dblclick * @result alert('Hello'); // Only executed for the first load
* *
* @name onedblclick * @name oneload
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the dblclick event on each of the matched elements. * @param Function fn A function to bind to the load event on each of the matched elements.
* @cat Events * @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 * elements. You must pass the identical function that was used in the original
* bind method. * bind method.
* *
* @example $("p").undblclick( myFunction ); * @example $("p").unload( myFunction );
* @before <p ondblclick="myFunction">Hello</p> * @before <p onload="myFunction">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name undblclick * @name unload
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the dblclick event on each of the matched elements. * @param Function fn A function to unbind from the load event on each of the matched elements.
* @cat Events * @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(); * @example $("p").unload();
* @before <p ondblclick="alert('Hello');">Hello</p> * @before <p onload="alert('Hello');">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name undblclick * @name unload
* @type jQuery * @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 <p>Hello</p> * @before <p>Hello</p>
* @result <p onmousedown="alert('Hello');">Hello</p> * @result <p onselect="alert('Hello');">Hello</p>
* *
* @name mousedown * @name select
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the mousedown event on each of the matched elements. * @param Function fn A function to bind to the select event on each of the matched elements.
* @cat Events * @cat Events/Form
*/ */
/** /**
* Trigger the mousedown event of each matched element. This causes all of the functions * Trigger the select event of each matched element. This causes all of the functions
* that have been bound to thet mousedown event to be executed. * that have been bound to thet select event to be executed.
* *
* @example $("p").mousedown(); * @example $("p").select();
* @before <p onmousedown="alert('Hello');">Hello</p> * @before <p onselect="alert('Hello');">Hello</p>
* @result alert('Hello'); * @result alert('Hello');
* *
* @name mousedown * @name select
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Form
*/ */
/** /**
* Bind a function to the mousedown event of each matched element, which will only be executed once. * Bind a function to the select 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 * 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). * only executed the first time it is triggered, and never again (unless it is re-bound).
* *
* @example $("p").onemousedown( function() { alert("Hello"); } ); * @example $("p").oneselect( function() { alert("Hello"); } );
* @before <p onmousedown="alert('Hello');">Hello</p> * @before <p onselect="alert('Hello');">Hello</p>
* @result alert('Hello'); // Only executed for the first mousedown * @result alert('Hello'); // Only executed for the first select
* *
* @name onemousedown * @name oneselect
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the mousedown event on each of the matched elements. * @param Function fn A function to bind to the select event on each of the matched elements.
* @cat Events * @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 * elements. You must pass the identical function that was used in the original
* bind method. * bind method.
* *
* @example $("p").unmousedown( myFunction ); * @example $("p").unselect( myFunction );
* @before <p onmousedown="myFunction">Hello</p> * @before <p onselect="myFunction">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unmousedown * @name unselect
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the mousedown event on each of the matched elements. * @param Function fn A function to unbind from the select event on each of the matched elements.
* @cat Events * @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(); * @example $("p").unselect();
* @before <p onmousedown="alert('Hello');">Hello</p> * @before <p onselect="alert('Hello');">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unmousedown * @name unselect
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Form
*/ */
/** /**
...@@ -774,7 +842,7 @@ new function(){ ...@@ -774,7 +842,7 @@ new function(){
* @name mouseup * @name mouseup
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the mouseup event on each of the matched elements. * @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(){ ...@@ -787,7 +855,7 @@ new function(){
* *
* @name mouseup * @name mouseup
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Mouse
*/ */
/** /**
...@@ -802,7 +870,7 @@ new function(){ ...@@ -802,7 +870,7 @@ new function(){
* @name onemouseup * @name onemouseup
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the mouseup event on each of the matched elements. * @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(){ ...@@ -817,7 +885,7 @@ new function(){
* @name unmouseup * @name unmouseup
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the mouseup event on each of the matched elements. * @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(){ ...@@ -829,211 +897,75 @@ new function(){
* *
* @name unmouseup * @name unmouseup
* @type jQuery * @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 <p>Hello</p> * @before <p>Hello</p>
* @result <p onmousemove="alert('Hello');">Hello</p> * @result <p onunload="alert('Hello');">Hello</p>
* *
* @name mousemove * @name unload
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the mousemove event on each of the matched elements. * @param Function fn A function to bind to the unload event on each of the matched elements.
* @cat Events * @cat Events/Browser
*/ */
/** /**
* Trigger the mousemove event of each matched element. This causes all of the functions * Trigger the unload event of each matched element. This causes all of the functions
* that have been bound to thet mousemove event to be executed. * that have been bound to thet unload event to be executed.
* *
* @example $("p").mousemove(); * @example $("p").unload();
* @before <p onmousemove="alert('Hello');">Hello</p> * @before <p onunload="alert('Hello');">Hello</p>
* @result alert('Hello'); * @result alert('Hello');
* *
* @name mousemove * @name unload
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Browser
*/ */
/** /**
* Bind a function to the mousemove event of each matched element, which will only be executed once. * Bind a function to the unload 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 * 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). * only executed the first time it is triggered, and never again (unless it is re-bound).
* *
* @example $("p").onemousemove( function() { alert("Hello"); } ); * @example $("p").oneunload( function() { alert("Hello"); } );
* @before <p onmousemove="alert('Hello');">Hello</p> * @before <p onunload="alert('Hello');">Hello</p>
* @result alert('Hello'); // Only executed for the first mousemove * @result alert('Hello'); // Only executed for the first unload
* *
* @name onemousemove * @name oneunload
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the mousemove event on each of the matched elements. * @param Function fn A function to bind to the unload event on each of the matched elements.
* @cat Events * @cat Events/Browser
*/
/**
* 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 <p onmousemove="myFunction">Hello</p>
* @result <p>Hello</p>
*
* @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 <p onmousemove="alert('Hello');">Hello</p>
* @result <p>Hello</p>
*
* @name unmousemove
* @type jQuery
* @cat Events
*/
/**
* Bind a function to the mouseover event of each matched element.
*
* @example $("p").mouseover( function() { alert("Hello"); } );
* @before <p>Hello</p>
* @result <p onmouseover="alert('Hello');">Hello</p>
*
* @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 <p onmouseover="alert('Hello');">Hello</p>
* @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 <p onmouseover="alert('Hello');">Hello</p>
* @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 <p onmouseover="myFunction">Hello</p>
* @result <p>Hello</p>
*
* @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 <p onmouseover="alert('Hello');">Hello</p>
* @result <p>Hello</p>
*
* @name unmouseover
* @type jQuery
* @cat Events
*/
/**
* Bind a function to the mouseout event of each matched element.
*
* @example $("p").mouseout( function() { alert("Hello"); } );
* @before <p>Hello</p>
* @result <p onmouseout="alert('Hello');">Hello</p>
*
* @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 <p onmouseout="alert('Hello');">Hello</p>
* @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 <p onmouseout="alert('Hello');">Hello</p>
* @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
*/ */
/** /**
* 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 * elements. You must pass the identical function that was used in the original
* bind method. * bind method.
* *
* @example $("p").unmouseout( myFunction ); * @example $("p").ununload( myFunction );
* @before <p onmouseout="myFunction">Hello</p> * @before <p onunload="myFunction">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unmouseout * @name ununload
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the mouseout event on each of the matched elements. * @param Function fn A function to unbind from the unload event on each of the matched elements.
* @cat Events * @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(); * @example $("p").ununload();
* @before <p onmouseout="alert('Hello');">Hello</p> * @before <p onunload="alert('Hello');">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unmouseout * @name ununload
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Browser
*/ */
/** /**
...@@ -1046,7 +978,7 @@ new function(){ ...@@ -1046,7 +978,7 @@ new function(){
* @name change * @name change
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the change event on each of the matched elements. * @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(){ ...@@ -1059,7 +991,7 @@ new function(){
* *
* @name change * @name change
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Form
*/ */
/** /**
...@@ -1074,7 +1006,7 @@ new function(){ ...@@ -1074,7 +1006,7 @@ new function(){
* @name onechange * @name onechange
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the change event on each of the matched elements. * @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(){ ...@@ -1089,7 +1021,7 @@ new function(){
* @name unchange * @name unchange
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the change event on each of the matched elements. * @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(){ ...@@ -1101,483 +1033,415 @@ new function(){
* *
* @name unchange * @name unchange
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Form
*/
/**
* Bind a function to the reset event of each matched element.
*
* @example $("p").reset( function() { alert("Hello"); } );
* @before <p>Hello</p>
* @result <p onreset="alert('Hello');">Hello</p>
*
* @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 <p onreset="alert('Hello');">Hello</p>
* @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 <p onreset="alert('Hello');">Hello</p>
* @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
*/ */
/** /**
* Removes a bound reset event from each of the matched * Bind a function to the mouseout event of each matched element.
* elements. You must pass the identical function that was used in the original
* bind method.
*
* @example $("p").unreset( myFunction );
* @before <p onreset="myFunction">Hello</p>
* @result <p>Hello</p>
*
* @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 <p onreset="alert('Hello');">Hello</p>
* @result <p>Hello</p>
*
* @name unreset
* @type jQuery
* @cat Events
*/
/**
* Bind a function to the select event of each matched element.
* *
* @example $("p").select( function() { alert("Hello"); } ); * @example $("p").mouseout( function() { alert("Hello"); } );
* @before <p>Hello</p> * @before <p>Hello</p>
* @result <p onselect="alert('Hello');">Hello</p> * @result <p onmouseout="alert('Hello');">Hello</p>
* *
* @name select * @name mouseout
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the select event on each of the matched elements. * @param Function fn A function to bind to the mouseout event on each of the matched elements.
* @cat Events * @cat Events/Mouse
*/ */
/** /**
* Trigger the select event of each matched element. This causes all of the functions * Trigger the mouseout event of each matched element. This causes all of the functions
* that have been bound to thet select event to be executed. * that have been bound to thet mouseout event to be executed.
* *
* @example $("p").select(); * @example $("p").mouseout();
* @before <p onselect="alert('Hello');">Hello</p> * @before <p onmouseout="alert('Hello');">Hello</p>
* @result alert('Hello'); * @result alert('Hello');
* *
* @name select * @name mouseout
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Mouse
*/ */
/** /**
* Bind a function to the select event of each matched element, which will only be executed once. * Bind a function to the mouseout 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 * 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). * only executed the first time it is triggered, and never again (unless it is re-bound).
* *
* @example $("p").oneselect( function() { alert("Hello"); } ); * @example $("p").onemouseout( function() { alert("Hello"); } );
* @before <p onselect="alert('Hello');">Hello</p> * @before <p onmouseout="alert('Hello');">Hello</p>
* @result alert('Hello'); // Only executed for the first select * @result alert('Hello'); // Only executed for the first mouseout
* *
* @name oneselect * @name onemouseout
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the select event on each of the matched elements. * @param Function fn A function to bind to the mouseout event on each of the matched elements.
* @cat Events * @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 * elements. You must pass the identical function that was used in the original
* bind method. * bind method.
* *
* @example $("p").unselect( myFunction ); * @example $("p").unmouseout( myFunction );
* @before <p onselect="myFunction">Hello</p> * @before <p onmouseout="myFunction">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unselect * @name unmouseout
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the select event on each of the matched elements. * @param Function fn A function to unbind from the mouseout event on each of the matched elements.
* @cat Events * @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(); * @example $("p").unmouseout();
* @before <p onselect="alert('Hello');">Hello</p> * @before <p onmouseout="alert('Hello');">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unselect * @name unmouseout
* @type jQuery * @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 <p>Hello</p> * @before <p>Hello</p>
* @result <p onsubmit="alert('Hello');">Hello</p> * @result <p onkeyup="alert('Hello');">Hello</p>
* *
* @name submit * @name keyup
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the submit event on each of the matched elements. * @param Function fn A function to bind to the keyup event on each of the matched elements.
* @cat Events * @cat Events/Keyboard
*/ */
/** /**
* Trigger the submit event of each matched element. This causes all of the functions * Trigger the keyup event of each matched element. This causes all of the functions
* that have been bound to thet submit event to be executed. * that have been bound to thet keyup event to be executed.
* *
* @example $("p").submit(); * @example $("p").keyup();
* @before <p onsubmit="alert('Hello');">Hello</p> * @before <p onkeyup="alert('Hello');">Hello</p>
* @result alert('Hello'); * @result alert('Hello');
* *
* @name submit * @name keyup
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Keyboard
*/ */
/** /**
* Bind a function to the submit event of each matched element, which will only be executed once. * Bind a function to the keyup 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 * 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). * only executed the first time it is triggered, and never again (unless it is re-bound).
* *
* @example $("p").onesubmit( function() { alert("Hello"); } ); * @example $("p").onekeyup( function() { alert("Hello"); } );
* @before <p onsubmit="alert('Hello');">Hello</p> * @before <p onkeyup="alert('Hello');">Hello</p>
* @result alert('Hello'); // Only executed for the first submit * @result alert('Hello'); // Only executed for the first keyup
* *
* @name onesubmit * @name onekeyup
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the submit event on each of the matched elements. * @param Function fn A function to bind to the keyup event on each of the matched elements.
* @cat Events * @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 * elements. You must pass the identical function that was used in the original
* bind method. * bind method.
* *
* @example $("p").unsubmit( myFunction ); * @example $("p").unkeyup( myFunction );
* @before <p onsubmit="myFunction">Hello</p> * @before <p onkeyup="myFunction">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unsubmit * @name unkeyup
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the submit event on each of the matched elements. * @param Function fn A function to unbind from the keyup event on each of the matched elements.
* @cat Events * @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(); * @example $("p").unkeyup();
* @before <p onsubmit="alert('Hello');">Hello</p> * @before <p onkeyup="alert('Hello');">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unsubmit * @name unkeyup
* @type jQuery * @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 <p>Hello</p> * @before <p>Hello</p>
* @result <p onkeydown="alert('Hello');">Hello</p> * @result <p onclick="alert('Hello');">Hello</p>
* *
* @name keydown * @name click
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the keydown event on each of the matched elements. * @param Function fn A function to bind to the click event on each of the matched elements.
* @cat Events * @cat Events/Mouse
*/ */
/** /**
* Trigger the keydown event of each matched element. This causes all of the functions * Trigger the click event of each matched element. This causes all of the functions
* that have been bound to thet keydown event to be executed. * that have been bound to thet click event to be executed.
* *
* @example $("p").keydown(); * @example $("p").click();
* @before <p onkeydown="alert('Hello');">Hello</p> * @before <p onclick="alert('Hello');">Hello</p>
* @result alert('Hello'); * @result alert('Hello');
* *
* @name keydown * @name click
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Mouse
*/ */
/** /**
* Bind a function to the keydown event of each matched element, which will only be executed once. * Bind a function to the click 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 * 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). * only executed the first time it is triggered, and never again (unless it is re-bound).
* *
* @example $("p").onekeydown( function() { alert("Hello"); } ); * @example $("p").oneclick( function() { alert("Hello"); } );
* @before <p onkeydown="alert('Hello');">Hello</p> * @before <p onclick="alert('Hello');">Hello</p>
* @result alert('Hello'); // Only executed for the first keydown * @result alert('Hello'); // Only executed for the first click
* *
* @name onekeydown * @name oneclick
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the keydown event on each of the matched elements. * @param Function fn A function to bind to the click event on each of the matched elements.
* @cat Events * @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 * elements. You must pass the identical function that was used in the original
* bind method. * bind method.
* *
* @example $("p").unkeydown( myFunction ); * @example $("p").unclick( myFunction );
* @before <p onkeydown="myFunction">Hello</p> * @before <p onclick="myFunction">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unkeydown * @name unclick
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the keydown event on each of the matched elements. * @param Function fn A function to unbind from the click event on each of the matched elements.
* @cat Events * @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(); * @example $("p").unclick();
* @before <p onkeydown="alert('Hello');">Hello</p> * @before <p onclick="alert('Hello');">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unkeydown * @name unclick
* @type jQuery * @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 <p>Hello</p> * @before <p>Hello</p>
* @result <p onkeypress="alert('Hello');">Hello</p> * @result <p onresize="alert('Hello');">Hello</p>
* *
* @name keypress * @name resize
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the keypress event on each of the matched elements. * @param Function fn A function to bind to the resize event on each of the matched elements.
* @cat Events * @cat Events/Browser
*/ */
/** /**
* Trigger the keypress event of each matched element. This causes all of the functions * Trigger the resize event of each matched element. This causes all of the functions
* that have been bound to thet keypress event to be executed. * that have been bound to thet resize event to be executed.
* *
* @example $("p").keypress(); * @example $("p").resize();
* @before <p onkeypress="alert('Hello');">Hello</p> * @before <p onresize="alert('Hello');">Hello</p>
* @result alert('Hello'); * @result alert('Hello');
* *
* @name keypress * @name resize
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Browser
*/ */
/** /**
* Bind a function to the keypress event of each matched element, which will only be executed once. * Bind a function to the resize 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 * 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). * only executed the first time it is triggered, and never again (unless it is re-bound).
* *
* @example $("p").onekeypress( function() { alert("Hello"); } ); * @example $("p").oneresize( function() { alert("Hello"); } );
* @before <p onkeypress="alert('Hello');">Hello</p> * @before <p onresize="alert('Hello');">Hello</p>
* @result alert('Hello'); // Only executed for the first keypress * @result alert('Hello'); // Only executed for the first resize
* *
* @name onekeypress * @name oneresize
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the keypress event on each of the matched elements. * @param Function fn A function to bind to the resize event on each of the matched elements.
* @cat Events * @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 * elements. You must pass the identical function that was used in the original
* bind method. * bind method.
* *
* @example $("p").unkeypress( myFunction ); * @example $("p").unresize( myFunction );
* @before <p onkeypress="myFunction">Hello</p> * @before <p onresize="myFunction">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unkeypress * @name unresize
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the keypress event on each of the matched elements. * @param Function fn A function to unbind from the resize event on each of the matched elements.
* @cat Events * @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(); * @example $("p").unresize();
* @before <p onkeypress="alert('Hello');">Hello</p> * @before <p onresize="alert('Hello');">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unkeypress * @name unresize
* @type jQuery * @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 <p>Hello</p> * @before <p>Hello</p>
* @result <p onkeyup="alert('Hello');">Hello</p> * @result <p onmousemove="alert('Hello');">Hello</p>
* *
* @name keyup * @name mousemove
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the keyup event on each of the matched elements. * @param Function fn A function to bind to the mousemove event on each of the matched elements.
* @cat Events * @cat Events/Mouse
*/ */
/** /**
* Trigger the keyup event of each matched element. This causes all of the functions * Trigger the mousemove event of each matched element. This causes all of the functions
* that have been bound to thet keyup event to be executed. * that have been bound to thet mousemove event to be executed.
* *
* @example $("p").keyup(); * @example $("p").mousemove();
* @before <p onkeyup="alert('Hello');">Hello</p> * @before <p onmousemove="alert('Hello');">Hello</p>
* @result alert('Hello'); * @result alert('Hello');
* *
* @name keyup * @name mousemove
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Mouse
*/ */
/** /**
* Bind a function to the keyup event of each matched element, which will only be executed once. * Bind a function to the mousemove 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 * 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). * only executed the first time it is triggered, and never again (unless it is re-bound).
* *
* @example $("p").onekeyup( function() { alert("Hello"); } ); * @example $("p").onemousemove( function() { alert("Hello"); } );
* @before <p onkeyup="alert('Hello');">Hello</p> * @before <p onmousemove="alert('Hello');">Hello</p>
* @result alert('Hello'); // Only executed for the first keyup * @result alert('Hello'); // Only executed for the first mousemove
* *
* @name onekeyup * @name onemousemove
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the keyup event on each of the matched elements. * @param Function fn A function to bind to the mousemove event on each of the matched elements.
* @cat Events * @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 * elements. You must pass the identical function that was used in the original
* bind method. * bind method.
* *
* @example $("p").unkeyup( myFunction ); * @example $("p").unmousemove( myFunction );
* @before <p onkeyup="myFunction">Hello</p> * @before <p onmousemove="myFunction">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unkeyup * @name unmousemove
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the keyup event on each of the matched elements. * @param Function fn A function to unbind from the mousemove event on each of the matched elements.
* @cat Events * @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(); * @example $("p").unmousemove();
* @before <p onkeyup="alert('Hello');">Hello</p> * @before <p onmousemove="alert('Hello');">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unkeyup * @name unmousemove
* @type jQuery * @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 <p>Hello</p> * @before <p>Hello</p>
* @result <p onerror="alert('Hello');">Hello</p> * @result <p onmousedown="alert('Hello');">Hello</p>
* *
* @name error * @name mousedown
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the error event on each of the matched elements. * @param Function fn A function to bind to the mousedown event on each of the matched elements.
* @cat Events * @cat Events/Mouse
*/ */
/** /**
* Trigger the error event of each matched element. This causes all of the functions * Trigger the mousedown event of each matched element. This causes all of the functions
* that have been bound to thet error event to be executed. * that have been bound to thet mousedown event to be executed.
* *
* @example $("p").error(); * @example $("p").mousedown();
* @before <p onerror="alert('Hello');">Hello</p> * @before <p onmousedown="alert('Hello');">Hello</p>
* @result alert('Hello'); * @result alert('Hello');
* *
* @name error * @name mousedown
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Mouse
*/ */
/** /**
* Bind a function to the error event of each matched element, which will only be executed once. * Bind a function to the mousedown 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 * 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). * only executed the first time it is triggered, and never again (unless it is re-bound).
* *
* @example $("p").oneerror( function() { alert("Hello"); } ); * @example $("p").onemousedown( function() { alert("Hello"); } );
* @before <p onerror="alert('Hello');">Hello</p> * @before <p onmousedown="alert('Hello');">Hello</p>
* @result alert('Hello'); // Only executed for the first error * @result alert('Hello'); // Only executed for the first mousedown
* *
* @name oneerror * @name onemousedown
* @type jQuery * @type jQuery
* @param Function fn A function to bind to the error event on each of the matched elements. * @param Function fn A function to bind to the mousedown event on each of the matched elements.
* @cat Events * @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 * elements. You must pass the identical function that was used in the original
* bind method. * bind method.
* *
* @example $("p").unerror( myFunction ); * @example $("p").unmousedown( myFunction );
* @before <p onerror="myFunction">Hello</p> * @before <p onmousedown="myFunction">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unerror * @name unmousedown
* @type jQuery * @type jQuery
* @param Function fn A function to unbind from the error event on each of the matched elements. * @param Function fn A function to unbind from the mousedown event on each of the matched elements.
* @cat Events * @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(); * @example $("p").unmousedown();
* @before <p onerror="alert('Hello');">Hello</p> * @before <p onmousedown="alert('Hello');">Hello</p>
* @result <p>Hello</p> * @result <p>Hello</p>
* *
* @name unerror * @name unmousedown
* @type jQuery * @type jQuery
* @cat Events * @cat Events/Mouse
*/ */
var e = ("blur,focus,load,resize,scroll,unload,click,dblclick," + var e = ("blur,focus,load,resize,scroll,unload,click,dblclick," +
......
...@@ -26,6 +26,7 @@ window.undefined = window.undefined; ...@@ -26,6 +26,7 @@ window.undefined = window.undefined;
* @constructor * @constructor
* @private * @private
* @name jQuery * @name jQuery
* @cat Core
*/ */
function jQuery(a,c) { function jQuery(a,c) {
...@@ -112,7 +113,7 @@ if ( typeof $ != "undefined" ) ...@@ -112,7 +113,7 @@ if ( typeof $ != "undefined" )
* *
* @name $ * @name $
* @param String expr An expression to search with. * @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 * @cat Core
* @type jQuery * @type jQuery
*/ */
...@@ -131,7 +132,7 @@ if ( typeof $ != "undefined" ) ...@@ -131,7 +132,7 @@ if ( typeof $ != "undefined" )
* be manipulated. * be manipulated.
* *
* @name $ * @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 * @cat Core
* @type jQuery * @type jQuery
*/ */
...@@ -143,7 +144,7 @@ if ( typeof $ != "undefined" ) ...@@ -143,7 +144,7 @@ if ( typeof $ != "undefined" )
* @desc Hides all the input elements within a form * @desc Hides all the input elements within a form
* *
* @name $ * @name $
* @param Array<DOMElement> elems An array of DOM elements to be encapsulated by a jQuery object. * @param Array<Element> elems An array of DOM elements to be encapsulated by a jQuery object.
* @cat Core * @cat Core
* @type jQuery * @type jQuery
*/ */
...@@ -493,9 +494,10 @@ jQuery.fn = jQuery.prototype = { ...@@ -493,9 +494,10 @@ jQuery.fn = jQuery.prototype = {
* stucture into a document, without ruining the original semantic * stucture into a document, without ruining the original semantic
* qualities of a document. * qualities of a document.
* *
* The way that is works is that it goes through the first element argument * This works by going through the first element
* provided and finds the deepest element within the structure - it is that * provided (which is generated, on the fly, from the provided HTML)
* element that will en-wrap everything else. * and finds the deepest ancestor element within its
* structure - it is that element that will en-wrap everything else.
* *
* @example $("p").wrap("<div class='wrap'></div>"); * @example $("p").wrap("<div class='wrap'></div>");
* @before <p>Test Paragraph.</p> * @before <p>Test Paragraph.</p>
...@@ -503,10 +505,27 @@ jQuery.fn = jQuery.prototype = { ...@@ -503,10 +505,27 @@ jQuery.fn = jQuery.prototype = {
* *
* @name wrap * @name wrap
* @type jQuery * @type jQuery
* @any String html A string of HTML, that will be created on the fly and wrapped around the target. * @param 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. * @cat DOM/Manipulation
* @any Array<Element> 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.
/**
* 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("<div class='wrap'></div>");
* @before <p>Test Paragraph.</p>
* @result <div class='wrap'><p>Test Paragraph.</p></div>
*
* @name wrap
* @type jQuery
* @param Element elem A DOM element that will be wrapped.
* @cat DOM/Manipulation * @cat DOM/Manipulation
*/ */
wrap: function() { wrap: function() {
...@@ -531,7 +550,8 @@ jQuery.fn = jQuery.prototype = { ...@@ -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 * This operation is similar to doing an appendChild to all the
* specified elements, adding them into the document. * specified elements, adding them into the document.
* *
...@@ -541,10 +561,37 @@ jQuery.fn = jQuery.prototype = { ...@@ -541,10 +561,37 @@ jQuery.fn = jQuery.prototype = {
* *
* @name append * @name append
* @type jQuery * @type jQuery
* @any String html A string of HTML, that will be created on the fly and appended to the target. * @param 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. * @cat DOM/Manipulation
* @any Array<Element> elems An array of elements, all of which will be appended. */
* @any Object obj Any object, converted to a string, then a text node.
/**
* 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 <p>I would like to say: </p><b id="foo">Hello</b>
* @result <p>I would like to say: <b id="foo">Hello</b></p>
*
* @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 <p>I would like to say: </p><b>Hello</b>
* @result <p>I would like to say: <b>Hello</b></p>
*
* @name append
* @type jQuery
* @param Array<Element> elems An array of elements, all of which will be appended.
* @cat DOM/Manipulation * @cat DOM/Manipulation
*/ */
append: function() { append: function() {
...@@ -554,20 +601,48 @@ jQuery.fn = jQuery.prototype = { ...@@ -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("<b>Hello</b>");
* @before <p>I would like to say: </p>
* @result <p><b>Hello</b>I would like to say: </p>
*
* @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 <p>I would like to say: </p><b id="foo">Hello</b>
* @result <p><b id="foo">Hello</b>I would like to say: </p>
*
* @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 * This operation is the best way to insert a set of elements inside, at the
* beginning, of all the matched element. * beginning, of all the matched element.
* *
* @example $("p").prepend("<b>Hello</b>"); * @example $("p").prepend( $("b") );
* @before <p>, how are you?</p> * @before <p>I would like to say: </p><b>Hello</b>
* @result <p><b>Hello</b>, how are you?</p> * @result <p><b>Hello</b>I would like to say: </p>
* *
* @name prepend * @name prepend
* @type jQuery * @type jQuery
* @any String html A string of HTML, that will be created on the fly and prepended to the target. * @param Array<Element> elems An array of elements, all of which will be appended.
* @any Element elem A DOM element that will be prepended.
* @any Array<Element> 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 * @cat DOM/Manipulation
*/ */
prepend: function() { prepend: function() {
...@@ -577,18 +652,42 @@ jQuery.fn = jQuery.prototype = { ...@@ -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("<b>Hello</b>"); * @example $("p").before("<b>Hello</b>");
* @before <p>how are you?</p> * @before <p>I would like to say: </p>
* @result <b>Hello</b><p>how are you?</p> * @result <b>Hello</b><p>I would like to say: </p>
*
* @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 <p>I would like to say: </p><b id="foo">Hello</b>
* @result <b id="foo">Hello</b><p>I would like to say: </p>
* *
* @name before * @name before
* @type jQuery * @type jQuery
* @any String html A string of HTML, that will be created on the fly and inserted. * @param Element elem A DOM element that will be appended.
* @any Element elem A DOM element that will beinserted. * @cat DOM/Manipulation
* @any Array<Element> elems An array of elements, all of which will be inserted. */
* @any Object obj Any object, converted to a string, then a text node.
/**
* Insert any number of elements before each of the matched elements.
*
* @example $("p").before( $("b") );
* @before <p>I would like to say: </p><b>Hello</b>
* @result <b>Hello</b><p>I would like to say: </p>
*
* @name before
* @type jQuery
* @param Array<Element> elems An array of elements, all of which will be appended.
* @cat DOM/Manipulation * @cat DOM/Manipulation
*/ */
before: function() { before: function() {
...@@ -597,19 +696,43 @@ jQuery.fn = jQuery.prototype = { ...@@ -597,19 +696,43 @@ jQuery.fn = jQuery.prototype = {
}); });
}, },
/**
* Insert any number of dynamically generated elements after each of the
* matched elements.
*
* @example $("p").after("<b>Hello</b>");
* @before <p>I would like to say: </p>
* @result <p>I would like to say: </p><b>Hello</b>
*
* @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 <b id="foo">Hello</b><p>I would like to say: </p>
* @result <p>I would like to say: </p><b id="foo">Hello</b>
*
* @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. * Insert any number of elements after each of the matched elements.
* *
* @example $("p").after("<p>I'm doing fine.</p>"); * @example $("p").after( $("b") );
* @before <p>How are you?</p> * @before <b>Hello</b><p>I would like to say: </p>
* @result <p>How are you?</p><p>I'm doing fine.</p> * @result <p>I would like to say: </p><b>Hello</b>
* *
* @name after * @name after
* @type jQuery * @type jQuery
* @any String html A string of HTML, that will be created on the fly and inserted. * @param Array<Element> elems An array of elements, all of which will be appended.
* @any Element elem A DOM element that will beinserted.
* @any Array<Element> 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 * @cat DOM/Manipulation
*/ */
after: function() { after: function() {
...@@ -823,6 +946,7 @@ jQuery.fn = jQuery.prototype = { ...@@ -823,6 +946,7 @@ jQuery.fn = jQuery.prototype = {
* @param Number int * @param Number int
* @param Function fn The function doing the DOM manipulation. * @param Function fn The function doing the DOM manipulation.
* @type jQuery * @type jQuery
* @cat Core
*/ */
domManip: function(args, table, dir, fn){ domManip: function(args, table, dir, fn){
var clone = this.size() > 1; var clone = this.size() > 1;
...@@ -856,6 +980,7 @@ jQuery.fn = jQuery.prototype = { ...@@ -856,6 +980,7 @@ jQuery.fn = jQuery.prototype = {
* @param Array a * @param Array a
* @param Array args * @param Array args
* @type jQuery * @type jQuery
* @cat Core
*/ */
pushStack: function(a,args) { pushStack: function(a,args) {
var fn = args && args[args.length-1]; var fn = args && args[args.length-1];
...@@ -882,15 +1007,15 @@ jQuery.fn = jQuery.prototype = { ...@@ -882,15 +1007,15 @@ jQuery.fn = jQuery.prototype = {
* @private * @private
* @name extend * @name extend
* @param Object obj * @param Object obj
* @param Object prop
* @type Object * @type Object
* @cat Core
*/ */
/** /**
* Extend one object with another, returning the original, * Extend one object with another, returning the original,
* modified, object. This is a great utility for simple inheritance. * modified, object. This is a great utility for simple inheritance.
* *
* @name jQuery.extend * @name $.extend
* @param Object obj The object to extend * @param Object obj The object to extend
* @param Object prop The object that will be merged into the first. * @param Object prop The object that will be merged into the first.
* @type Object * @type Object
...@@ -907,6 +1032,7 @@ jQuery.extend({ ...@@ -907,6 +1032,7 @@ jQuery.extend({
* @private * @private
* @name init * @name init
* @type undefined * @type undefined
* @cat Core
*/ */
init: function(){ init: function(){
jQuery.initDone = true; jQuery.initDone = true;
...@@ -965,7 +1091,7 @@ jQuery.extend({ ...@@ -965,7 +1091,7 @@ jQuery.extend({
* A generic iterator function, which can be used to seemlessly * A generic iterator function, which can be used to seemlessly
* iterate over both objects and arrays. * iterate over both objects and arrays.
* *
* @name jQuery.each * @name $.each
* @param Object obj The object, or array, to iterate over. * @param Object obj The object, or array, to iterate over.
* @param Object fn The function that will be executed on every object. * @param Object fn The function that will be executed on every object.
* @type Object * @type Object
...@@ -1264,8 +1390,10 @@ jQuery.extend({ ...@@ -1264,8 +1390,10 @@ jQuery.extend({
* @test t( "Is Visible", "input:visible", ["text1","text2","radio1","radio2","check1","check2"] ); * @test t( "Is Visible", "input:visible", ["text1","text2","radio1","radio2","check1","check2"] );
* @test t( "Is Hidden", "input:hidden", ["hidden1","hidden2"] ); * @test t( "Is Hidden", "input:hidden", ["hidden1","hidden2"] );
* *
* @name jQuery.find * @name $.find
* @type Array<Element>
* @private * @private
* @cat Core
*/ */
find: function( t, context ) { find: function( t, context ) {
// Make sure that the context is a DOM Element // Make sure that the context is a DOM Element
...@@ -1466,10 +1594,10 @@ jQuery.extend({ ...@@ -1466,10 +1594,10 @@ jQuery.extend({
/** /**
* Remove the whitespace from the beginning and end of a string. * Remove the whitespace from the beginning and end of a string.
* *
* @private * @name $.trim
* @name jQuery.trim
* @type String * @type String
* @param String str The string to trim. * @param String str The string to trim.
* @cat Javascript
*/ */
trim: function(t){ trim: function(t){
return t.replace(/^\s+|\s+$/g, ""); return t.replace(/^\s+|\s+$/g, "");
...@@ -1479,9 +1607,10 @@ jQuery.extend({ ...@@ -1479,9 +1607,10 @@ jQuery.extend({
* All ancestors of a given element. * All ancestors of a given element.
* *
* @private * @private
* @name jQuery.parents * @name $.parents
* @type Array<Element> * @type Array<Element>
* @param Element elem The element to find the ancestors of. * @param Element elem The element to find the ancestors of.
* @cat DOM/Traversing
*/ */
parents: function( elem ){ parents: function( elem ){
var matched = []; var matched = [];
...@@ -1497,9 +1626,10 @@ jQuery.extend({ ...@@ -1497,9 +1626,10 @@ jQuery.extend({
* All elements on a specified axis. * All elements on a specified axis.
* *
* @private * @private
* @name jQuery.sibling * @name $.sibling
* @type Array * @type Array
* @param Element elem The element to find all the siblings of (including itself). * @param Element elem The element to find all the siblings of (including itself).
* @cat DOM/Traversing
*/ */
sibling: function(elem, pos, not) { sibling: function(elem, pos, not) {
var elems = []; var elems = [];
...@@ -1525,11 +1655,11 @@ jQuery.extend({ ...@@ -1525,11 +1655,11 @@ jQuery.extend({
/** /**
* Merge two arrays together, removing all duplicates. * Merge two arrays together, removing all duplicates.
* *
* @private * @name $.merge
* @name jQuery.merge
* @type Array * @type Array
* @param Array a The first array to merge. * @param Array a The first array to merge.
* @param Array b The second array to merge. * @param Array b The second array to merge.
* @cat Javascript
*/ */
merge: function(first, second) { merge: function(first, second) {
var result = []; var result = [];
...@@ -1562,12 +1692,12 @@ jQuery.extend({ ...@@ -1562,12 +1692,12 @@ jQuery.extend({
* in to this method will be passed two arguments: 'a' (which is the * 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). * array item) and 'i' (which is the index of the item in the array).
* *
* @private * @name $.grep
* @name jQuery.grep
* @type Array * @type Array
* @param Array array The Array to find items in. * @param Array array The Array to find items in.
* @param Function fn The function to process each item against. * @param Function fn The function to process each item against.
* @param Boolean inv Invert the selection - select the opposite of the function. * @param Boolean inv Invert the selection - select the opposite of the function.
* @cat Javascript
*/ */
grep: function(elems, fn, inv) { grep: function(elems, fn, inv) {
// If a string is passed in for the function, make a function // If a string is passed in for the function, make a function
...@@ -1594,11 +1724,11 @@ jQuery.extend({ ...@@ -1594,11 +1724,11 @@ jQuery.extend({
* from the array. Both of these changes imply that the size of the array may not * 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. * be the same size upon completion, as it was when it started.
* *
* @private * @name $.map
* @name jQuery.map
* @type Array * @type Array
* @param Array array The Array to translate. * @param Array array The Array to translate.
* @param Function fn The function to process each item against. * @param Function fn The function to process each item against.
* @cat Javascript
*/ */
map: function(elems, fn) { map: function(elems, fn) {
// If a string is passed in for the function, make a function // If a string is passed in for the function, make a function
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment