Changed "Hash" to "Map" in docs
authorJörn Zaefferer <joern.zaefferer@gmail.com>
Thu, 4 Jan 2007 10:03:34 +0000 (10:03 +0000)
committerJörn Zaefferer <joern.zaefferer@gmail.com>
Thu, 4 Jan 2007 10:03:34 +0000 (10:03 +0000)
build/docs/js/doc.js
src/ajax/ajax.js
src/jquery/jquery.js

index 4c607fe..4beeb43 100644 (file)
@@ -4,7 +4,7 @@ var types = {
        String: "A string of characters.",
        Number: "A numeric valid.",
        Element: "The Javascript object representation of a DOM Element.",
-       Hash: "A Javascript object that contains key/value pairs in the form of properties and values.",
+       Map: "A Javascript object that contains key/value pairs in the form of properties and values.",
        "Array&lt;Element&gt;": "An Array of DOM Elements.",
        "Array&lt;String&gt;": "An Array of strings.",
        Function: "A reference to a Javascript function.",
index e37632f..45159a5 100644 (file)
@@ -11,7 +11,7 @@ jQuery.fn.extend({
         * @name loadIfModified
         * @type jQuery
         * @param String url The URL of the HTML file to load.
-        * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
+        * @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
         */
@@ -275,7 +275,7 @@ jQuery.extend({
         * @name $.get
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
-        * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
+        * @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
         */
@@ -316,7 +316,7 @@ jQuery.extend({
         * @name $.getIfModified
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
-        * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
+        * @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
         */
@@ -364,7 +364,7 @@ jQuery.extend({
         * @name $.getJSON
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
-        * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
+        * @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
         */
@@ -393,7 +393,7 @@ jQuery.extend({
         * @name $.post
         * @type XMLHttpRequest
         * @param String url The URL of the page to load.
-        * @param Hash params (optional) A set of key/value pairs that will be sent to the server.
+        * @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
         */
@@ -444,12 +444,14 @@ jQuery.extend({
         *   global: false,
         *   type: "POST"
         * } );
+        * $.ajax({ data: myData });
         * @desc Sets the defaults for AJAX requests to the url "/xmlhttp/",
-        * disables global handlers and uses POST instead of GET
+        * disables global handlers and uses POST instead of GET. The following
+        * AJAX requests then sends some data without having to set anything else.
         *
         * @name $.ajaxSetup
         * @type undefined
-        * @param Object settings Key/value pairs for ajax options
+        * @param Map settings Key/value pairs to use for all AJAX requests
         * @cat AJAX
         */
        ajaxSetup: function(settings) {
@@ -584,8 +586,9 @@ jQuery.extend({
         * 
         * @name $.ajax
         * @type XMLHttpRequest
-        * @param Hash prop A set of properties to initialize the request with.
+        * @param Map properties Key/value pairs to initialize the request with.
         * @cat AJAX
+        * @see ajaxSetup(Map)
         */
        ajax: function( s ) {
                // TODO introduce global settings, allowing the client to modify them for all requests, not only timeout
index ebf9828..282741f 100644 (file)
@@ -312,8 +312,8 @@ jQuery.fn = jQuery.prototype = {
         * @example $("img").each(function(i){
         *   this.src = "test" + i + ".jpg";
         * });
-        * @before <img/> <img/>
-        * @result <img src="test0.jpg"/> <img src="test1.jpg"/>
+        * @before <img/><img/>
+        * @result <img src="test0.jpg"/><img src="test1.jpg"/>
         * @desc Iterates over two images and sets their src property
         *
         * @name each
@@ -371,7 +371,8 @@ jQuery.fn = jQuery.prototype = {
         */
 
        /**
-        * Set a hash of key/value object properties to all matched elements.
+        * Set a key/value object as properties to all matched elements.
+        *
         * This serves as the best way to set a large number of properties
         * on all matched elements.
         *
@@ -381,7 +382,7 @@ jQuery.fn = jQuery.prototype = {
         *
         * @name attr
         * @type jQuery
-        * @param Hash prop A set of key/value pairs to set as object properties.
+        * @param Map properties Key/value pairs to set as object properties.
         * @cat DOM
         */
 
@@ -389,7 +390,7 @@ jQuery.fn = jQuery.prototype = {
         * Set a single property to a value, on all matched elements.
         *
         * Note that you can't set the name property of input elements in IE.
-        * Use $(html) or $().append(html) or $().html(html) to create elements
+        * Use $(html) or .append(html) or .html(html) to create elements
         * on the fly including the name property.
         *
         * @example $("img").attr("src","test.jpg");
@@ -454,7 +455,8 @@ jQuery.fn = jQuery.prototype = {
         */
 
        /**
-        * Set a hash of key/value style properties to all matched elements.
+        * Set a key/value object as style properties to all matched elements.
+        *
         * This serves as the best way to set a large number of style properties
         * on all matched elements.
         *
@@ -464,7 +466,7 @@ jQuery.fn = jQuery.prototype = {
         *
         * @name css
         * @type jQuery
-        * @param Hash prop A set of key/value pairs to set as style properties.
+        * @param Map properties Key/value pairs to set as style properties.
         * @cat CSS
         */