Skip to content

Commit 47dd9de

Browse files
kswedbergkswedberg
committed
Add summarizing description for multi-entry methods.
Fixes jquery#129
1 parent f81c0a4 commit 47dd9de

19 files changed

+33
-17
lines changed

‎entries/attr.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0"?>
22
<entries>
3+
<desc>Get the value of an attribute for the first element in the set of matched elements or set one or more attributes for every matched element.</desc>
34
<entry type="method" name="attr" return="String">
45
<title>.attr()</title>
56
<signature>
@@ -157,4 +158,4 @@ $("img").attr("src", function() {
157158
<category slug="version/1.1"/>
158159
<category slug="version/1.6"/>
159160
</entry>
160-
</entries>
161+
</entries>

‎entries/closest.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ $('li.item-a').closest('#one', listItemII)
147147
<desc>A DOM element within which a matching element may be found. If no context is passed in then the context of the jQuery set will be used instead.</desc>
148148
</argument>
149149
</signature>
150-
<desc>Gets an array of all the elements and selectors matched against the current element up through the DOM tree.</desc>
150+
<desc>Get an array of all the elements and selectors matched against the current element up through the DOM tree.</desc>
151151
<longdesc>
152152
<p><strong>This signature (only!) is deprecated as of jQuery 1.7 and <em>removed</em> in jQuery 1.8</strong>. It was primarily meant to be used internally or by plugin authors.</p>
153153
</longdesc>

‎entries/css.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0"?>
22
<entries>
3+
<desc>Get the value of a style property for the first element in the set of matched elements or set one or more CSS properties for every matched element.</desc>
34
<entry type="method" name="css" return="String">
45
<title>.css()</title>
56
<signature>
@@ -65,7 +66,7 @@ div { width:60px; height:60px; margin:5px; float:left; }
6566
<desc>A map of property-value pairs to set.</desc>
6667
</argument>
6768
</signature>
68-
<desc>Set one or more CSS properties for the set of matched elements.</desc>
69+
<desc>Set one or more CSS properties for the set of matched elements.</desc>
6970
<longdesc>
7071
<p>As with the <code>.prop()</code> method, the <code>.css()</code> method makes setting properties of elements quick and easy. This method can take either a property name and value as separate parameters, or a single map of key-value pairs (JavaScript object notation).</p>
7172
<p>Also, jQuery can equally interpret the CSS and DOM formatting of multiple-word properties. For example, jQuery understands and returns the correct value for both <code>.css({'background-color': '#ffe', 'border-left': '5px solid #ccc'})</code> and <code>.css({backgroundColor: '#ffe', borderLeft: '5px solid #ccc'})</code>. Notice that with the DOM notation, quotation marks around the property names are optional, but with CSS notation they're required due to the hyphen in the name.</p>

‎entries/data.xml

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0"?>
22
<entries>
3+
<desc>Store arbitrary data associated with the matched elements or return the value at the named data store for the first element in the set of matched elements.</desc>
34
<entry type="method" name="data" return="jQuery">
45
<title>.data()</title>
56
<signature>
@@ -67,7 +68,7 @@ $("span:last").text($("div").data("test").last);
6768
<signature>
6869
<added>1.4</added>
6970
</signature>
70-
<desc>Returns value at named data store for the first element in the jQuery collection, as set by data(name, value).</desc>
71+
<desc>Return the value at the named data store for the first element in the jQuery collection, as set by data(name, value) or by an HTML5 data-* attribute.</desc>
7172
<longdesc>
7273
<p>The <code>.data()</code> method allows us to attach data of any type to DOM elements in a way that is safe from circular references and therefore from memory leaks. We can retrieve several distinct values for a single element one at a time, or as a set:</p>
7374
<pre><code>
@@ -150,4 +151,4 @@ $("button").click(function(e) {
150151
<category slug="version/1.4"/>
151152
<category slug="version/1.4.3"/>
152153
</entry>
153-
</entries>
154+
</entries>

‎entries/height.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0"?>
22
<entries>
3+
<desc>Get the current computed height for the first element in the set of matched elements or set the height of every matched element.</desc>
34
<entry type="method" name="height" return="Integer">
45
<title>.height()</title>
56
<signature>
@@ -98,4 +99,4 @@ $(document).height(); // returns height of HTML document</code></pre>
9899
<category slug="version/1.0"/>
99100
<category slug="version/1.4.1"/>
100101
</entry>
101-
</entries>
102+
</entries>

‎entries/hover.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0"?>
22
<entries>
3+
<desc>Bind one or two handlers to the matched elements, to be executed when the mouse pointer enters and leaves the elements.</desc>
34
<entry type="method" name="hover" return="jQuery">
45
<title>.hover()</title>
56
<desc>Bind two handlers to the matched elements, to be executed when the mouse pointer enters and leaves the elements.</desc>
@@ -112,4 +113,4 @@ $("li")
112113
<category slug="events/mouse-events"/>
113114
<category slug="version/1.0"/>
114115
</entry>
115-
</entries>
116+
</entries>

‎entries/html.xml

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0"?>
22
<entries>
3+
<desc>Get the HTML contents of the first element in the set of matched elements or set the HTML contents of every matched element.</desc>
34
<entry type="method" name="html" return="String">
45
<title>.html()</title>
56
<signature>

‎entries/jQuery.browser.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,4 +124,4 @@ if ( $.browser.msie ) {
124124
<category slug="version/1.0"/>
125125
<category slug="version/1.1.3"/>
126126
</entry>
127-
</entries>
127+
</entries>

‎entries/jQuery.data.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0"?>
22
<entries>
3+
<desc>Store arbitrary data associated with the specified element and/or return the value that was set.</desc>
34
<entry type="method" name="jQuery.data" return="Object">
45
<title>jQuery.data()</title>
56
<signature>
@@ -122,4 +123,4 @@ span { color:red; }
122123
<category slug="version/1.4"/>
123124
<category slug="version/1.4.3"/>
124125
</entry>
125-
</entries>
126+
</entries>

‎entries/jQuery.queue.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0"?>
22
<entries>
3+
<desc>Show or manipulate the queue of functions to be executed on the matched element.</desc>
34
<entry type="method" name="jQuery.queue" return="Array">
45
<title>jQuery.queue()</title>
56
<signature>
@@ -144,4 +145,4 @@ div.newcolor { background:blue; }
144145
<category slug="utilities"/>
145146
<category slug="version/1.3"/>
146147
</entry>
147-
</entries>
148+
</entries>

‎entries/jQuery.xml

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0"?>
22
<entries>
3+
<desc>Return a collection of matched elements either found in the DOM based on passed argument(s) or created by passing an HTML string.</desc>
34
<entry type="method" name="jQuery" return="jQuery">
45
<title>jQuery()</title>
56
<signature>

‎entries/offset.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0"?>
22
<entries>
3+
<desc>Get the current coordinates of the first element, or set the coordinates of every element, in the set of matched elements, relative to the document.</desc>
34
<entry type="method" name="offset" return="Object">
45
<title>.offset()</title>
56
<signature>
@@ -87,4 +88,4 @@ div.abs { width:50px; height:50px; position:absolute;
8788
<category slug="version/1.2"/>
8889
<category slug="version/1.4"/>
8990
</entry>
90-
</entries>
91+
</entries>

‎entries/prop.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0"?>
22
<entries>
3+
<desc>Get the value of a property for the first element in the set of matched elements or set one or more properties for every matched element.</desc>
34
<entry type="method" name="prop" return="String">
45
<title>.prop()</title>
56
<signature>
@@ -160,4 +161,4 @@ $("input[type='checkbox']").prop({
160161
<category slug="manipulation/general-attributes"/>
161162
<category slug="version/1.6"/>
162163
</entry>
163-
</entries>
164+
</entries>

‎entries/queue.xml

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0"?>
22
<entries>
3+
<desc>Show or manipulate the queue of functions to be executed on the matched elements.</desc>
34
<entry type="method" name="queue" return="Array">
45
<title>.queue()</title>
56
<signature>

‎entries/scrollLeft.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0"?>
22
<entries>
3+
<desc>Get the current horizontal position of the scroll bar for the first element in the set of matched elements or set the horizontal position of the scroll bar for every matched element.</desc>
34
<entry type="method" name="scrollLeft" return="Integer">
45
<title>.scrollLeft()</title>
56
<signature>
@@ -62,4 +63,4 @@ $("p:last").text( "scrollLeft:" + p.scrollLeft() );
6263
<category slug="manipulation/style-properties"/>
6364
<category slug="version/1.2.6"/>
6465
</entry>
65-
</entries>
66+
</entries>

‎entries/scrollTop.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<signature>
66
<added>1.2.6</added>
77
</signature>
8-
<desc>Get the current vertical position of the scroll bar for the first element in the set of matched elements.</desc>
8+
<desc>Get the current vertical position of the scroll bar for the first element in the set of matched elements or set the vertical position of the scroll bar for every matched element.</desc>
99
<longdesc>
1010
<p>The vertical scroll position is the same as the number of pixels that are hidden from view above the scrollable area. If the scroll bar is at the very top, or if the element is not scrollable, this number will be <code>0</code>.</p>
1111
</longdesc>
@@ -59,4 +59,4 @@ overflow:auto;
5959
<category slug="manipulation/style-properties"/>
6060
<category slug="version/1.2.6"/>
6161
</entry>
62-
</entries>
62+
</entries>

‎entries/text.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0"?>
22
<entries>
3+
<desc>Get the combined text contents of each element in the set of matched elements, including their descendants, or set the text contents of the matched elements.</desc>
34
<entry type="method" name="text" return="String">
45
<title>.text()</title>
56
<signature>
@@ -97,4 +98,4 @@ $("p:last").html(str);
9798
<category slug="version/1.0"/>
9899
<category slug="version/1.4"/>
99100
</entry>
100-
</entries>
101+
</entries>

‎entries/val.xml

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0"?>
22
<entries>
3+
<desc>Get the current value of the first element in the set of matched elements or set the value of every matched element.</desc>
34
<entry type="method" name="val" return="String, Number, Array">
45
<title>.val()</title>
56
<signature>

‎entries/width.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<?xml version="1.0"?>
22
<entries>
3+
<desc>Get the current computed width for the first element in the set of matched elements or set the width of every matched element.</desc>
34
<entry type="method" name="width" return="Integer">
45
<title>.width()</title>
56
<signature>
@@ -104,4 +105,4 @@ div { width: 70px; height: 50px; float:left; margin: 5px;
104105
<category slug="version/1.0"/>
105106
<category slug="version/1.4.1"/>
106107
</entry>
107-
</entries>
108+
</entries>

0 commit comments

Comments
 (0)