From d7b73ea5c7440c49c804b3cafe67e84aafbdd064 Mon Sep 17 00:00:00 2001 From: John Resig Date: Sun, 7 Jan 2007 09:20:19 +0000 Subject: [PATCH] Improved the categories of a bunch of docs, upped the version to 1.1. --- src/ajax/ajax.js | 36 ++++++++++++++++++------------------ src/event/event.js | 50 +++++++++++++++++++++++++------------------------- src/fx/fx.js | 18 +++++++++--------- src/jquery/jquery.js | 34 +++++++++++++++++----------------- version.txt | 2 +- 5 files changed, 70 insertions(+), 70 deletions(-) diff --git a/src/ajax/ajax.js b/src/ajax/ajax.js index 93bb4e2..9a9e0eb 100644 --- a/src/ajax/ajax.js +++ b/src/ajax/ajax.js @@ -13,7 +13,7 @@ jQuery.fn.extend({ * @param String url The URL of the HTML file to load. * @param Map params (optional) Key/value pairs that will be sent to the server. * @param Function callback (optional) A function to be executed whenever the data is loaded (parameters: responseText, status and response itself). - * @cat AJAX + * @cat Ajax */ loadIfModified: function( url, params, callback ) { this.load( url, params, callback, 1 ); @@ -41,7 +41,7 @@ jQuery.fn.extend({ * @param String url The URL of the HTML file to load. * @param Object params (optional) A set of key/value pairs that will be sent as data to the server. * @param Function callback (optional) A function to be executed whenever the data is loaded (parameters: responseText, status and response itself). - * @cat AJAX + * @cat Ajax */ load: function( url, params, callback, ifModified ) { if ( url.constructor == Function ) @@ -105,7 +105,7 @@ jQuery.fn.extend({ * * @name serialize * @type String - * @cat AJAX + * @cat Ajax */ serialize: function() { return jQuery.param( this ); @@ -118,7 +118,7 @@ jQuery.fn.extend({ * @name evalScripts * @type jQuery * @private - * @cat AJAX + * @cat Ajax */ evalScripts: function() { return this.find('script').each(function(){ @@ -152,7 +152,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @name ajaxStart * @type jQuery * @param Function callback The function to execute. - * @cat AJAX + * @cat Ajax */ /** @@ -166,7 +166,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @name ajaxStop * @type jQuery * @param Function callback The function to execute. - * @cat AJAX + * @cat Ajax */ /** @@ -183,7 +183,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @name ajaxComplete * @type jQuery * @param Function callback The function to execute. - * @cat AJAX + * @cat Ajax */ /** @@ -201,7 +201,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @name ajaxSuccess * @type jQuery * @param Function callback The function to execute. - * @cat AJAX + * @cat Ajax */ /** @@ -219,7 +219,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @name ajaxError * @type jQuery * @param Function callback The function to execute. - * @cat AJAX + * @cat Ajax */ /** @@ -236,7 +236,7 @@ if ( jQuery.browser.msie && typeof XMLHttpRequest == "undefined" ) * @name ajaxSend * @type jQuery * @param Function callback The function to execute. - * @cat AJAX + * @cat Ajax */ jQuery.each( "ajaxStart,ajaxStop,ajaxComplete,ajaxError,ajaxSuccess,ajaxSend".split(","), function(i,o){ jQuery.fn[o] = function(f){ @@ -269,7 +269,7 @@ jQuery.extend({ * @param String url The URL of the page to load. * @param Map params (optional) Key/value pairs that will be sent to the server. * @param Function callback (optional) A function to be executed whenever the data is loaded. - * @cat AJAX + * @cat Ajax */ get: function( url, data, callback, type, ifModified ) { // shift arguments if data argument was ommited @@ -311,7 +311,7 @@ jQuery.extend({ * @param String url The URL of the page to load. * @param Map params (optional) Key/value pairs that will be sent to the server. * @param Function callback (optional) A function to be executed whenever the data is loaded. - * @cat AJAX + * @cat Ajax */ getIfModified: function( url, data, callback, type ) { return jQuery.get(url, data, callback, type, 1); @@ -334,7 +334,7 @@ jQuery.extend({ * @type XMLHttpRequest * @param String url The URL of the page to load. * @param Function callback (optional) A function to be executed whenever the data is loaded. - * @cat AJAX + * @cat Ajax */ getScript: function( url, callback ) { return jQuery.get(url, null, callback, "script"); @@ -359,7 +359,7 @@ jQuery.extend({ * @param String url The URL of the page to load. * @param Map params (optional) Key/value pairs that will be sent to the server. * @param Function callback A function to be executed whenever the data is loaded. - * @cat AJAX + * @cat Ajax */ getJSON: function( url, data, callback ) { return jQuery.get(url, data, callback, "json"); @@ -388,7 +388,7 @@ jQuery.extend({ * @param String url The URL of the page to load. * @param Map params (optional) Key/value pairs that will be sent to the server. * @param Function callback (optional) A function to be executed whenever the data is loaded. - * @cat AJAX + * @cat Ajax */ post: function( url, data, callback, type ) { return jQuery.ajax({ @@ -421,7 +421,7 @@ jQuery.extend({ * @name $.ajaxTimeout * @type undefined * @param Number time How long before an AJAX request times out. - * @cat AJAX + * @cat Ajax */ ajaxTimeout: function( timeout ) { jQuery.ajaxSettings.timeout = timeout; @@ -445,7 +445,7 @@ jQuery.extend({ * @name $.ajaxSetup * @type undefined * @param Map settings Key/value pairs to use for all AJAX requests - * @cat AJAX + * @cat Ajax */ ajaxSetup: function( settings ) { jQuery.extend( jQuery.ajaxSettings, settings ); @@ -580,7 +580,7 @@ jQuery.extend({ * @name $.ajax * @type XMLHttpRequest * @param Map properties Key/value pairs to initialize the request with. - * @cat AJAX + * @cat Ajax * @see ajaxSetup(Map) */ ajax: function( s ) { diff --git a/src/event/event.js b/src/event/event.js index 9b3788b..6e8a45f 100644 --- a/src/event/event.js +++ b/src/event/event.js @@ -486,7 +486,7 @@ new function(){ * @name scroll * @type jQuery * @param Function fn A function to bind to the scroll event on each of the matched elements. - * @cat Events/Browser + * @cat Events */ /** @@ -501,7 +501,7 @@ new function(){ * @name submit * @type jQuery * @param Function fn A function to bind to the submit event on each of the matched elements. - * @cat Events/Form + * @cat Events */ /** @@ -516,7 +516,7 @@ new function(){ * * @name submit * @type jQuery - * @cat Events/Form + * @cat Events */ /** @@ -529,7 +529,7 @@ new function(){ * @name focus * @type jQuery * @param Function fn A function to bind to the focus event on each of the matched elements. - * @cat Events/UI + * @cat Events */ /** @@ -545,7 +545,7 @@ new function(){ * * @name focus * @type jQuery - * @cat Events/UI + * @cat Events */ /** @@ -558,7 +558,7 @@ new function(){ * @name keydown * @type jQuery * @param Function fn A function to bind to the keydown event on each of the matched elements. - * @cat Events/Keyboard + * @cat Events */ /** @@ -571,7 +571,7 @@ new function(){ * @name dblclick * @type jQuery * @param Function fn A function to bind to the dblclick event on each of the matched elements. - * @cat Events/Mouse + * @cat Events */ /** @@ -584,7 +584,7 @@ new function(){ * @name keypress * @type jQuery * @param Function fn A function to bind to the keypress event on each of the matched elements. - * @cat Events/Keyboard + * @cat Events */ /** @@ -597,7 +597,7 @@ new function(){ * @name error * @type jQuery * @param Function fn A function to bind to the error event on each of the matched elements. - * @cat Events/Browser + * @cat Events */ /** @@ -610,7 +610,7 @@ new function(){ * @name blur * @type jQuery * @param Function fn A function to bind to the blur event on each of the matched elements. - * @cat Events/UI + * @cat Events */ /** @@ -626,7 +626,7 @@ new function(){ * * @name blur * @type jQuery - * @cat Events/UI + * @cat Events */ /** @@ -639,7 +639,7 @@ new function(){ * @name load * @type jQuery * @param Function fn A function to bind to the load event on each of the matched elements. - * @cat Events/Browser + * @cat Events */ /** @@ -652,7 +652,7 @@ new function(){ * @name select * @type jQuery * @param Function fn A function to bind to the select event on each of the matched elements. - * @cat Events/Form + * @cat Events */ /** @@ -665,7 +665,7 @@ new function(){ * * @name select * @type jQuery - * @cat Events/Form + * @cat Events */ /** @@ -678,7 +678,7 @@ new function(){ * @name mouseup * @type jQuery * @param Function fn A function to bind to the mouseup event on each of the matched elements. - * @cat Events/Mouse + * @cat Events */ /** @@ -691,7 +691,7 @@ new function(){ * @name unload * @type jQuery * @param Function fn A function to bind to the unload event on each of the matched elements. - * @cat Events/Browser + * @cat Events */ /** @@ -704,7 +704,7 @@ new function(){ * @name change * @type jQuery * @param Function fn A function to bind to the change event on each of the matched elements. - * @cat Events/Form + * @cat Events */ /** @@ -717,7 +717,7 @@ new function(){ * @name mouseout * @type jQuery * @param Function fn A function to bind to the mouseout event on each of the matched elements. - * @cat Events/Mouse + * @cat Events */ /** @@ -730,7 +730,7 @@ new function(){ * @name keyup * @type jQuery * @param Function fn A function to bind to the keyup event on each of the matched elements. - * @cat Events/Keyboard + * @cat Events */ /** @@ -743,7 +743,7 @@ new function(){ * @name click * @type jQuery * @param Function fn A function to bind to the click event on each of the matched elements. - * @cat Events/Mouse + * @cat Events */ /** @@ -756,7 +756,7 @@ new function(){ * * @name click * @type jQuery - * @cat Events/Mouse + * @cat Events */ /** @@ -769,7 +769,7 @@ new function(){ * @name resize * @type jQuery * @param Function fn A function to bind to the resize event on each of the matched elements. - * @cat Events/Browser + * @cat Events */ /** @@ -782,7 +782,7 @@ new function(){ * @name mousemove * @type jQuery * @param Function fn A function to bind to the mousemove event on each of the matched elements. - * @cat Events/Mouse + * @cat Events */ /** @@ -795,7 +795,7 @@ new function(){ * @name mousedown * @type jQuery * @param Function fn A function to bind to the mousedown event on each of the matched elements. - * @cat Events/Mouse + * @cat Events */ /** @@ -808,7 +808,7 @@ new function(){ * @name mouseover * @type jQuery * @param Function fn A function to bind to the mousedown event on each of the matched elements. - * @cat Events/Mouse + * @cat Events */ jQuery.each( ("blur,focus,load,resize,scroll,unload,click,dblclick," + "mousedown,mouseup,mousemove,mouseover,mouseout,change,select," + diff --git a/src/fx/fx.js b/src/fx/fx.js index bb3a17a..6f7f9d1 100644 --- a/src/fx/fx.js +++ b/src/fx/fx.js @@ -21,7 +21,7 @@ jQuery.fn.extend({ * @param String|Number speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). * @param Function callback (optional) A function to be executed whenever the animation completes. * @param String easing (optional) easing effect - * @cat Effects/Animations + * @cat Effects * @see hide(String|Number,Function) */ show: function(speed,callback){ @@ -51,7 +51,7 @@ jQuery.fn.extend({ * @param String|Number speed A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). * @param Function callback (optional) A function to be executed whenever the animation completes. * @param String easing (optional) easing effect - * @cat Effects/Animations + * @cat Effects * @see show(String|Number,Function) */ hide: function(speed,callback){ @@ -78,7 +78,7 @@ jQuery.fn.extend({ * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). * @param Function callback (optional) A function to be executed whenever the animation completes. * @param String easing (optional) easing effect - * @cat Effects/Animations + * @cat Effects * @see slideUp(String|Number,Function) * @see slideToggle(String|Number,Function) */ @@ -104,7 +104,7 @@ jQuery.fn.extend({ * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). * @param Function callback (optional) A function to be executed whenever the animation completes. * @param String easing (optional) easing effect - * @cat Effects/Animations + * @cat Effects * @see slideDown(String|Number,Function) * @see slideToggle(String|Number,Function) */ @@ -130,7 +130,7 @@ jQuery.fn.extend({ * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). * @param Function callback (optional) A function to be executed whenever the animation completes. * @param String easing (optional) easing effect - * @cat Effects/Animations + * @cat Effects * @see slideDown(String|Number,Function) * @see slideUp(String|Number,Function) */ @@ -160,7 +160,7 @@ jQuery.fn.extend({ * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). * @param Function callback (optional) A function to be executed whenever the animation completes. * @param String easing (optional) easing effect - * @cat Effects/Animations + * @cat Effects * @see fadeOut(String|Number,Function) * @see fadeTo(String|Number,Number,Function) */ @@ -187,7 +187,7 @@ jQuery.fn.extend({ * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). * @param Function callback (optional) A function to be executed whenever the animation completes. * @param String easing (optional) easing effect - * @cat Effects/Animations + * @cat Effects * @see fadeIn(String|Number,Function) * @see fadeTo(String|Number,Number,Function) */ @@ -215,7 +215,7 @@ jQuery.fn.extend({ * @param Number opacity The opacity to fade to (a number from 0 to 1). * @param Function callback (optional) A function to be executed whenever the animation completes. * @param String easing (optional) easing effect - * @cat Effects/Animations + * @cat Effects * @see fadeIn(String|Number,Function) * @see fadeOut(String|Number,Function) */ @@ -249,7 +249,7 @@ jQuery.fn.extend({ * @param String|Number speed (optional) A string representing one of the three predefined speeds ("slow", "normal", or "fast") or the number of milliseconds to run the animation (e.g. 1000). * @param Function callback (optional) A function to be executed whenever the animation completes. * @param String easing (optional) easing effect - * @cat Effects/Animations + * @cat Effects */ animate: function( prop, speed, easing, callback ) { return this.queue(function(){ diff --git a/src/jquery/jquery.js b/src/jquery/jquery.js index 3b0f82e..30fd03d 100644 --- a/src/jquery/jquery.js +++ b/src/jquery/jquery.js @@ -365,7 +365,7 @@ jQuery.fn = jQuery.prototype = { * @name attr * @type Object * @param String name The name of the property to access. - * @cat DOM + * @cat DOM/Attributes */ /** @@ -382,7 +382,7 @@ jQuery.fn = jQuery.prototype = { * @name attr * @type jQuery * @param Map properties Key/value pairs to set as object properties. - * @cat DOM + * @cat DOM/Attributes */ /** @@ -401,7 +401,7 @@ jQuery.fn = jQuery.prototype = { * @type jQuery * @param String key The name of the property to set. * @param Object value The value to set the property to. - * @cat DOM + * @cat DOM/Attributes */ attr: function( key, value, type ) { // Check to see if we're setting style values @@ -496,7 +496,7 @@ jQuery.fn = jQuery.prototype = { * * @name text * @type String - * @cat DOM + * @cat DOM/Attributes */ /** @@ -511,7 +511,7 @@ jQuery.fn = jQuery.prototype = { * @name text * @type String * @param String val The text value to set the contents of the element to. - * @cat DOM + * @cat DOM/Attributes */ text: function(e) { // A surprisingly high number of people expect the @@ -1098,7 +1098,7 @@ jQuery.fn = jQuery.prototype = { * @param Object prop1 The object that will be merged into the first. * @param Object propN (optional) More objects to merge into the first * @type Object - * @cat Javascript + * @cat JavaScript */ jQuery.extend = jQuery.fn.extend = function() { // copy reference to target object @@ -1179,7 +1179,7 @@ jQuery.extend({ * @param Object obj The object, or array, to iterate over. * @param Function fn The function that will be executed on every object. * @type Object - * @cat Javascript + * @cat JavaScript */ // args is for internal usage only each: function( obj, fn, args ) { @@ -1420,7 +1420,7 @@ jQuery.extend({ * @name $.trim * @type String * @param String str The string to trim. - * @cat Javascript + * @cat JavaScript */ trim: function(t){ return t.replace(/^\s+|\s+$/g, ""); @@ -1463,7 +1463,7 @@ jQuery.extend({ * @type Array * @param Array first The first array to merge. * @param Array second The second array to merge. - * @cat Javascript + * @cat JavaScript */ merge: function(first, second) { var r = [].slice.call( first, 0 ); @@ -1498,7 +1498,7 @@ jQuery.extend({ * @param Array array The Array to find items in. * @param Function fn The function to process each item against. * @param Boolean inv Invert the selection - select the opposite of the function. - * @cat Javascript + * @cat JavaScript */ grep: function(elems, fn, inv) { // If a string is passed in for the function, make a function @@ -1552,7 +1552,7 @@ jQuery.extend({ * @type Array * @param Array array The Array to translate. * @param Function fn The function to process each item against. - * @cat Javascript + * @cat JavaScript */ map: function(elems, fn) { // If a string is passed in for the function, make a function @@ -1608,7 +1608,7 @@ jQuery.extend({ * @property * @name $.browser * @type Boolean - * @cat Javascript + * @cat JavaScript */ /* @@ -1617,7 +1617,7 @@ jQuery.extend({ * @property * @name $.boxModel * @type Boolean - * @cat Javascript + * @cat JavaScript */ new function() { var b = navigator.userAgent.toLowerCase(); @@ -1878,7 +1878,7 @@ jQuery.each({ * @name removeAttr * @type jQuery * @param String name The name of the attribute to remove. - * @cat DOM + * @cat DOM/Attributes */ /** @@ -1935,7 +1935,7 @@ jQuery.each({ * @name addClass * @type jQuery * @param String class A CSS class to add to the elements - * @cat DOM + * @cat DOM/Attributes * @see removeClass(String) */ @@ -1953,7 +1953,7 @@ jQuery.each({ * @name removeClass * @type jQuery * @param String class (optional) A CSS class to remove from the elements - * @cat DOM + * @cat DOM/Attributes * @see addClass(String) */ @@ -1968,7 +1968,7 @@ jQuery.each({ * @name toggleClass * @type jQuery * @param String class A CSS class with which to toggle the elements - * @cat DOM + * @cat DOM/Attributes */ /** diff --git a/version.txt b/version.txt index ee90284..9459d4b 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -1.0.4 +1.1 -- 1.7.10.4