changed type="Object" to type="PlainObject"

cleaned up formatting of entries through slideUp

Author: kswedberg

entries/jQuery.Callbacks.xml

@@ -8,12 +8,12 @@
   <desc>A multi-purpose callbacks list object that provides a powerful way to manage callback lists.</desc>
   <longdesc>
 
-<p>The <code>$.Callbacks()</code> function is internally used to provide the base functionality behind the jQuery <code>$.ajax()</code> and <code>$.Deferred()</code> components. It can be used as a similar base to define functionality for new components.</p>
-<p><code>$.Callbacks()</code> support a number of methods including <code><a href="/callbacks.add/">callbacks.add()</a></code>,<code><a href="/callbacks.remove/">callbacks.remove()</a></code>, <code><a href="/callbacks.fire/">callbacks.fire()</a></code> and <code><a href="/callbacks.disable/">callbacks.disable()</a></code>.</p>
-<h3 id="getting-started">Getting started</h3>
+    <p>The <code>$.Callbacks()</code> function is internally used to provide the base functionality behind the jQuery <code>$.ajax()</code> and <code>$.Deferred()</code> components. It can be used as a similar base to define functionality for new components.</p>
+    <p><code>$.Callbacks()</code> support a number of methods including <code><a href="/callbacks.add/">callbacks.add()</a></code>,<code><a href="/callbacks.remove/">callbacks.remove()</a></code>, <code><a href="/callbacks.fire/">callbacks.fire()</a></code> and <code><a href="/callbacks.disable/">callbacks.disable()</a></code>.</p>
+    <h3 id="getting-started">Getting started</h3>
 
-<p>The following are two sample methods named <code>fn1</code> and <code>fn2</code>:</p>
-<pre>
+    <p>The following are two sample methods named <code>fn1</code> and <code>fn2</code>:</p>
+    <pre>
 function fn1( value ){
     console.log( value );
 }

entries/jQuery.browser.xml

@@ -4,19 +4,20 @@
   <longdesc>
     <p>The <code>$.browser</code> property provides information about the web browser that is accessing the page, as reported by the browser itself. It contains flags for each of the four most prevalent browser classes (Internet Explorer, Mozilla, Webkit, and Opera) as well as version information.</p>
 
-<p>Available flags are:</p>
-<ul>
-  <li>webkit (as of jQuery 1.4)</li>
-  <li>safari (deprecated)</li>
-  <li>opera</li>
-  <li>msie</li>
-  <li>mozilla</li>
-</ul>
+    <p>Available flags are:</p>
+    <ul>
+      <li>webkit (as of jQuery 1.4)</li>
+      <li>safari (deprecated)</li>
+      <li>opera</li>
+      <li>msie</li>
+      <li>mozilla</li>
+    </ul>
 
-<p>This property is available immediately. It is therefore safe to use it to determine whether or not to call <code>$(document).ready()</code>.
-The <code>$.browser</code> property is deprecated in jQuery 1.3, and its functionality may be moved to a team-supported plugin in a future release of jQuery.</p>
+    <p>This property is available immediately. It is therefore safe to use it to determine whether or not to call <code>$(document).ready()</code>.
+    The <code>$.browser</code> property is deprecated in jQuery 1.3, and its functionality may be moved to a team-supported plugin in a future release of jQuery.</p>
 
-<p>Because <code>$.browser</code> uses <code>navigator.userAgent</code> to determine the platform, it is vulnerable to spoofing by the user or misrepresentation by the browser itself. It is always best to avoid browser-specific code entirely where possible. The <code><a href="http://api.jquery.com/jQuery.support/">$.support</a></code> property is available for detection of support for particular features rather than relying on <code>$.browser</code>. </p></longdesc>
+    <p>Because <code>$.browser</code> uses <code>navigator.userAgent</code> to determine the platform, it is vulnerable to spoofing by the user or misrepresentation by the browser itself. It is always best to avoid browser-specific code entirely where possible. The <code><a href="http://api.jquery.com/jQuery.support/">$.support</a></code> property is available for detection of support for particular features rather than relying on <code>$.browser</code>. </p>
+  </longdesc>
   <example>
     <desc>Show the browser info.</desc>
     <code><![CDATA[

entries/jQuery.contains.xml

@@ -16,7 +16,7 @@
   <desc>Check if an element is inside another. Text and comment nodes are not supported.</desc>
   <code><![CDATA[jQuery.contains(document.documentElement, document.body); // true
 jQuery.contains(document.body, document.documentElement); // false]]></code>
-                </example>
-            <category name="Utilities" slug="utilities"/>
+</example>
+<category name="Utilities" slug="utilities"/>
 <category name="Version 1.4" slug="1.4"/>
 </entry>

entries/jQuery.fx.interval.xml

@@ -17,11 +17,11 @@ $("input").click(function(){
   $("div").toggle( 3000 );
 });
   ]]></code>
-<css><![CDATA[
-    div { width:50px; height:30px; margin:5px; float:left;
-          background:green; }
-    ]]></css>
-      <html><![CDATA[<p><input type="button" value="Run"/></p>
+  <css><![CDATA[
+div { width:50px; height:30px; margin:5px; float:left;
+      background:green; }
+]]></css>
+  <html><![CDATA[<p><input type="button" value="Run"/></p>
 <div></div>]]></html>
 </example>
 <category name="Custom" slug="custom-effects"/>

entries/jQuery.fx.off.xml

@@ -11,9 +11,9 @@
     </ul>
     <p>Animations can be turned back on by setting the property to <code>false</code>.</p>
   </longdesc>
-  <example>
-    <desc>Toggle animation on and off</desc>
-    <code><![CDATA[
+<example>
+  <desc>Toggle animation on and off</desc>
+  <code><![CDATA[
 var toggleFx = function() {
   $.fx.off = !$.fx.off;
 };
@@ -25,13 +25,13 @@ $("input").click(function(){
   $("div").toggle("slow");
 });
   ]]></code>
-<css><![CDATA[
+  <css><![CDATA[
     div { width:50px; height:30px; margin:5px; float:left;
           background:green; }
-    ]]></css>
-      <html><![CDATA[<p><input type="button" value="Run"/> <button>Toggle fx</button></p>
+  ]]></css>
+  <html><![CDATA[<p><input type="button" value="Run"/> <button>Toggle fx</button></p>
 <div></div>]]></html>
-                  </example>
+</example>
 <category name="Custom" slug="custom-effects"/>
 <category name="Properties of the Global jQuery Object" slug="global-jquery-object-properties"/>
 <category name="Version 1.3" slug="1.3"/>

entries/jQuery.getJSON.xml

@@ -14,7 +14,7 @@
   <desc>Load JSON-encoded data from the server using a GET HTTP request.</desc>
   <longdesc>
     <p>This is a shorthand Ajax function, which is equivalent to:</p>
-        <pre>$.ajax({
+    <pre>$.ajax({
   url: <em>url</em>,
   dataType: 'json',
   data: <em>data</em>,

entries/jQuery.getScript.xml

@@ -16,30 +16,30 @@
   success: <em>success</em>
 });
 </pre>
-        <p>The script is executed in the global context, so it can refer to other variables and use jQuery functions. Included scripts can have some impact on the current page.</p>
-        <h4 id="success-callback">
-          Success Callback
-        </h4>
-        <p>The callback is passed the returned JavaScript file. This is generally not useful as the script will already have run at this point.</p>
-        <pre>$(".result").html("&lt;p&gt;Lorem ipsum dolor sit amet.&lt;/p&gt;");</pre>
-        <p>Scripts are included and run by referencing the file name:</p>
+      <p>The script is executed in the global context, so it can refer to other variables and use jQuery functions. Included scripts can have some impact on the current page.</p>
+      <h4 id="success-callback">
+        Success Callback
+      </h4>
+      <p>The callback is passed the returned JavaScript file. This is generally not useful as the script will already have run at this point.</p>
+      <pre>$(".result").html("&lt;p&gt;Lorem ipsum dolor sit amet.&lt;/p&gt;");</pre>
+      <p>Scripts are included and run by referencing the file name:</p>
 <pre>$.getScript("ajax/test.js", function(data, textStatus, jqxhr) {
    console.log(data); //data returned
    console.log(textStatus); //success
    console.log(jqxhr.status); //200
    console.log('Load was performed.');
 });</pre>
 
-        <h4 id="handling-errors">Handling Errors</h4>
-        <p>As of jQuery 1.5, you may use <a href="http://api.jquery.com/deferred.fail/"><code>.fail()</code></a> to account for errors:</p>
+      <h4 id="handling-errors">Handling Errors</h4>
+      <p>As of jQuery 1.5, you may use <a href="http://api.jquery.com/deferred.fail/"><code>.fail()</code></a> to account for errors:</p>
 <pre>
 $.getScript("ajax/test.js")
 .done(function(script, textStatus) {
   console.log( textStatus );
 })
 .fail(function(jqxhr, settings, exception) {
   $( "div.log" ).text( "Triggered ajaxError handler." );
-});  
+});
 </pre>
         <p>Prior to jQuery 1.5, the global <code>.ajaxError()</code> callback event had to be used in order to handle <code>$.getScript()</code> errors:</p>
 <pre>
@@ -49,15 +49,15 @@ $( "div.log" ).ajaxError(function(e, jqxhr, settings, exception) {
   }
 });
 </pre>
-        <h4 id="caching-requests">Caching Responses</h4>
-        <p>Be default, <code>$.getScript()</code> sets the cache setting to <code>false</code>. This appends a timestamped query parameter to the request URL to ensure that the browser downloads the script each time it is requested. You can override this feature by setting the cache property globally using <a href="http://api.jquery.com/jquery.ajaxsetup/"><code>$.ajaxSetup()</code></a>: </p>
+      <h4 id="caching-requests">Caching Responses</h4>
+      <p>Be default, <code>$.getScript()</code> sets the cache setting to <code>false</code>. This appends a timestamped query parameter to the request URL to ensure that the browser downloads the script each time it is requested. You can override this feature by setting the cache property globally using <a href="http://api.jquery.com/jquery.ajaxsetup/"><code>$.ajaxSetup()</code></a>: </p>
 <pre>
 $.ajaxSetup({
   cache: true
 });
 </pre>
-        <p>Alternatively, you could define a new method that uses the more flexible <code>$.ajax()</code> method.</p>
-</longdesc>
+      <p>Alternatively, you could define a new method that uses the more flexible <code>$.ajax()</code> method.</p>
+    </longdesc>
 <example>
   <desc>Define a $.cachedScript() method that allows fetching a cached script:</desc>
   <code>jQuery.cachedScript = function(url, options) {
@@ -80,9 +80,9 @@ $.cachedScript("ajax/test.js").done(function(script, textStatus) {
 });
 </code>
 </example>
-                <example>
-                    <desc>Load the <a href="http://github.com/jquery/jquery-color">official jQuery Color Animation plugin</a> dynamically and bind some color animations to occur once the new functionality is loaded.</desc>
-                    <code><![CDATA[
+<example>
+  <desc>Load the <a href="http://github.com/jquery/jquery-color">official jQuery Color Animation plugin</a> dynamically and bind some color animations to occur once the new functionality is loaded.</desc>
+  <code><![CDATA[
 $.getScript("/scripts/jquery.color.js", function() {
   $("#go").click(function(){
     $(".block").animate( { backgroundColor: "pink" }, 1000)

entries/jQuery.globalEval.xml

@@ -1,20 +1,23 @@
-            <entry type='method' name="jQuery.globalEval" return="">
-                <signature>
-                  <added>1.0.4</added>
-                  <argument name="code" type="String">
-                    <desc>The JavaScript code to execute.</desc>
-                  </argument>
-                </signature>
-                <desc>Execute some JavaScript code globally.</desc>
-                <longdesc><p>This method behaves differently from using a normal JavaScript <code>eval()</code> in that it's executed within the global context (which is important for loading external scripts dynamically).</p></longdesc>
-                <example>
-                    <desc>Execute a script in the global context.</desc>
-                    <code><![CDATA[function test(){
+<entry type='method' name="jQuery.globalEval" return="">
+  <signature>
+    <added>1.0.4</added>
+    <argument name="code" type="String">
+      <desc>The JavaScript code to execute.</desc>
+    </argument>
+  </signature>
+  <desc>Execute some JavaScript code globally.</desc>
+  <longdesc>
+    <p>This method behaves differently from using a normal JavaScript <code>eval()</code> in that it's executed within the global context (which is important for loading external scripts dynamically).</p>
+  </longdesc>
+<example>
+  <desc>Execute a script in the global context.</desc>
+  <code><![CDATA[function test(){
     jQuery.globalEval("var newVar = true;")
-}
-test();
-// newVar === true]]></code>
-                </example>
-            <category name="Utilities" slug="utilities"/>
+    }
+    test();
+    // newVar === true
+  ]]></code>
+</example>
+<category name="Utilities" slug="utilities"/>
 <category name="Version 1.0.4" slug="1.0.4"/>
 </entry>

entries/jQuery.hasData.xml

@@ -7,11 +7,11 @@
   </signature>
   <desc>Determine whether an element has any jQuery data associated with it.</desc>
   <longdesc><p>The <code>jQuery.hasData()</code> method provides a way to determine if an element currently has any values that were set using <code><a href='/jQuery.data'>jQuery.data()</a></code>. If no data is associated with an element (there is no data object at all or the data object is empty), the method returns <code>false</code>; otherwise it returns <code>true</code>.</p>
-<p>The primary advantage of <code>jQuery.hasData(element)</code> is that it does not create and associate a data object with the element if none currently exists. In contrast, <code>jQuery.data(element)</code> always returns a data object to the caller, creating one if no data object previously existed.
+    <p>The primary advantage of <code>jQuery.hasData(element)</code> is that it does not create and associate a data object with the element if none currently exists. In contrast, <code>jQuery.data(element)</code> always returns a data object to the caller, creating one if no data object previously existed.
 </p>
-<p>Note that jQuery's event system uses the jQuery data API to store event handlers. Therefore, binding an event to an element using <code>.on()</code>, <code>.bind()</code>, <code>.live()</code>, <code>.delegate()</code>, or one of the shorthand event methods also associates a data object with that element.
+    <p>Note that jQuery's event system uses the jQuery data API to store event handlers. Therefore, binding an event to an element using <code>.on()</code>, <code>.bind()</code>, <code>.live()</code>, <code>.delegate()</code>, or one of the shorthand event methods also associates a data object with that element.
 </p>
-</longdesc>
+  </longdesc>
   <example>
     <desc>Set data on an element and see the results of hasData.</desc>
     <code><![CDATA[

entries/jQuery.holdReady.xml

@@ -1,22 +1,21 @@
 <entry type='method' name="jQuery.holdReady" return="undefined">
   <desc>Holds or releases the execution of jQuery's ready event.</desc>
-    <signature>
-      <added>1.6</added>
-      <argument name="hold" type="Boolean">
-        <desc>Indicates whether the ready hold is being requested or released</desc>
-      </argument>
-    </signature>
-
-<longdesc>
-<p>The <code>$.holdReady()</code> method allows the caller to delay jQuery's ready event. This <em>advanced feature</em> would typically be used by dynamic script loaders that want to load additional JavaScript such as jQuery plugins before allowing the ready event to occur, even though the DOM may be ready. This method must be called early in the document, such as in the <code>&lt;head&gt;</code> immediately after the jQuery script tag. Calling this method after the ready event has already fired will have no effect. </p>
-<p>To delay the ready event, first call <code>$.holdReady(true)</code>. When the ready event should be released to execute, call <code>$.holdReady(false)</code>. Note that multiple holds can be put on the ready event, one for each <code>$.holdReady(true)</code> call. The ready event will not actually fire until all holds have been released with a corresponding number of <code>$.holdReady(false)</code> calls <em>and</em> the normal document ready conditions are met. (See <a href="http://api.jquery.com/ready/"><code>ready</code></a> for more information.)</p>
-</longdesc>
+  <signature>
+    <added>1.6</added>
+    <argument name="hold" type="Boolean">
+      <desc>Indicates whether the ready hold is being requested or released</desc>
+    </argument>
+  </signature>
+  <longdesc>
+    <p>The <code>$.holdReady()</code> method allows the caller to delay jQuery's ready event. This <em>advanced feature</em> would typically be used by dynamic script loaders that want to load additional JavaScript such as jQuery plugins before allowing the ready event to occur, even though the DOM may be ready. This method must be called early in the document, such as in the <code>&lt;head&gt;</code> immediately after the jQuery script tag. Calling this method after the ready event has already fired will have no effect. </p>
+    <p>To delay the ready event, first call <code>$.holdReady(true)</code>. When the ready event should be released to execute, call <code>$.holdReady(false)</code>. Note that multiple holds can be put on the ready event, one for each <code>$.holdReady(true)</code> call. The ready event will not actually fire until all holds have been released with a corresponding number of <code>$.holdReady(false)</code> calls <em>and</em> the normal document ready conditions are met. (See <a href="http://api.jquery.com/ready/"><code>ready</code></a> for more information.)</p>
+  </longdesc>
 <example>
-    <desc>Delay the ready event until a custom plugin has loaded.</desc>
-    <code><![CDATA[
+  <desc>Delay the ready event until a custom plugin has loaded.</desc>
+  <code><![CDATA[
 $.holdReady(true);
 $.getScript("myplugin.js", function() {
-     $.holdReady(false);
+  $.holdReady(false);
 });
 ]]></code>
 </example>

entries/jQuery.inArray.xml

@@ -1,5 +1,6 @@
 <entry type='method' name="jQuery.inArray" return="Number">
-  <signature><added>1.2</added>
+  <signature>
+    <added>1.2</added>
     <argument name="value" type="Any">
       <desc>The value to search for.</desc>
     </argument>
@@ -10,12 +11,11 @@
       <desc>The index of the array at which to begin the search. The default is 0, which will search the whole array.</desc>
     </argument>
   </signature>
-<desc>Search for a specified value within an array and return its index (or -1 if not found).</desc>
-  <longdesc><p>The <code>$.inArray()</code> method is similar to JavaScript's native <code>.indexOf()</code> method in that it returns -1 when it doesn't find a match. If the first element within the array matches <code>value</code>, <code>$.inArray()</code> returns 0.</p> 
-
+  <desc>Search for a specified value within an array and return its index (or -1 if not found).</desc>
+  <longdesc><p>The <code>$.inArray()</code> method is similar to JavaScript's native <code>.indexOf()</code> method in that it returns -1 when it doesn't find a match. If the first element within the array matches <code>value</code>, <code>$.inArray()</code> returns 0.</p>
     <p>Because JavaScript treats 0 as loosely equal to false (i.e. 0 == false, but 0 !== false), if we're checking for the presence of <code>value</code> within <code>array</code>, we need to check if it's not equal to (or greater than) -1.</p>
   </longdesc>
-                
+
 <example>
   <desc>Report the index of some elements in the array.</desc>
   <code><![CDATA[var arr = [ 4, "Pete", 8, "John" ];