Skip to content

Commit 11c93b9

Browse files
esxtjvantoll
esx
authored and
tjvantoll
committed
All: Added structured types for higer order function parameters
Some function parameters of function type (e.g. handlers, callbacks) was described with the signature in the name-attribute, eg. <argument name="function(index, value)" type="Function">. This have been modified to used nested <argument>-elements to describe the signatures more consistently. Changed some argument type from XMLHttpRequest to jsXHR Some callback functions was indicated to receive XMLHttpRequest rather than jsXHR. Fixed spelling and changed 'ajaxOptions' to 'PlainObject' The ajaxOptions/ajaxSettings options object is not documented as a seperate type, so now changed to PlainObject. Changed misspelling of jsXHR to jqXHR. Changed nargument names to valid identifers to avoid confusion Argument names with whitespace like "jQuery object" are confusing, because it might easily be mistaken for two arguments when reading the signature. Argument names like "-index" are also confusing since they look like an expression rather than a name. I have renamed the argument names to be valid javascript identifiers, just like actual argument names have to be. Also changed argument type "Object" and "PlainObject" to "JQuery" where the prose documentation indicates that the type is a jQuery object. Changed argument name 'jQueryObject' to 'selection' As per discussion on #jquery-content. Also changed type from 'Object' to 'jQuery' where prose indicates a jQuery object. Closes gh-419
1 parent a93a1cc commit 11c93b9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+357
-129
lines changed

‎entries/add.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
</signature>
2222
<signature>
2323
<added>1.3.2</added>
24-
<argument name="jQuery object" type="jQuery">
24+
<argument name="selection" type="jQuery">
2525
<desc>An existing jQuery object to add to the set of matched elements.</desc>
2626
</argument>
2727
</signature>

‎entries/addClass.xml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,11 @@
99
</signature>
1010
<signature>
1111
<added>1.4</added>
12-
<argument name="function(index, currentClass)" type="Function">
12+
<argument name="function" type="Function">
1313
<desc>A function returning one or more space-separated class names to be added to the existing class name(s). Receives the index position of the element in the set and the existing class name(s) as arguments. Within the function, <code>this</code> refers to the current element in the set.</desc>
14+
<argument name="index" type="Integer" />
15+
<argument name="currentClassName" type="String" />
16+
<return type="String"/>
1417
</argument>
1518
</signature>
1619
<desc>Adds the specified class(es) to each of the set of matched elements.</desc>

‎entries/after.xml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,15 @@
2020
</signature>
2121
<signature>
2222
<added>1.4</added>
23-
<argument name="function(index)" type="Function">
23+
<argument name="function" type="Function">
2424
<desc>A function that returns an HTML string, DOM element(s), or jQuery object to insert after each element in the set of matched elements. Receives the index position of the element in the set as an argument. Within the function, <code>this</code> refers to the current element in the set.</desc>
25+
<argument name="index" type="Integer" />
26+
<argument name="html" type="String" />
27+
<return>
28+
<type name="htmlString"/>
29+
<type name="Element"/>
30+
<type name="jQuery"/>
31+
</return>
2532
</argument>
2633
</signature>
2734
<desc>Insert content, specified by the parameter, after each element in the set of matched elements.</desc>

‎entries/ajaxComplete.xml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
<title>.ajaxComplete()</title>
44
<signature>
55
<added>1.0</added>
6-
<argument name="handler(event, XMLHttpRequest, ajaxOptions)" type="Function">
6+
<argument name="handler" type="Function">
7+
<argument name="event" type="Event" />
8+
<argument name="jqXHR" type="jqXHR" />
9+
<argument name="ajaxOptions" type="PlainObject" />
710
<desc>The function to be invoked.</desc>
811
</argument>
912
</signature>

‎entries/ajaxError.xml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,12 @@
33
<title>.ajaxError()</title>
44
<signature>
55
<added>1.0</added>
6-
<argument name="handler(event, jqXHR, ajaxSettings, thrownError)" type="Function">
6+
<argument name="handler" type="Function">
77
<desc>The function to be invoked.</desc>
8+
<argument name="event" type="Event" />
9+
<argument name="jqXHR" type="jqXHR" />
10+
<argument name="ajaxSettings" type="PlainObject" />
11+
<argument name="thrownError" type="String" />
812
</argument>
913
</signature>
1014
<desc>Register a handler to be called when Ajax requests complete with an error. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>

‎entries/ajaxSend.xml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,11 @@
33
<title>.ajaxSend()</title>
44
<signature>
55
<added>1.0</added>
6-
<argument name="handler(event, jqXHR, ajaxOptions)" type="Function">
6+
<argument name="handler" type="Function">
77
<desc>The function to be invoked.</desc>
8+
<argument name="event" type="Event" />
9+
<argument name="jqXHR" type="jqXHR" />
10+
<argument name="ajaxOptions" type="PlainObject" />
811
</argument>
912
</signature>
1013
<desc>Attach a function to be executed before an Ajax request is sent. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>

‎entries/ajaxStart.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<title>.ajaxStart()</title>
44
<signature>
55
<added>1.0</added>
6-
<argument name="handler()" type="Function">
6+
<argument name="handler" type="Function">
77
<desc>The function to be invoked.</desc>
88
</argument>
99
</signature>

‎entries/ajaxStop.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<desc>Register a handler to be called when all Ajax requests have completed. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
55
<signature>
66
<added>1.0</added>
7-
<argument name="handler()" type="Function">
7+
<argument name="handler" type="Function">
88
<desc>The function to be invoked.</desc>
99
</argument>
1010
</signature>

‎entries/ajaxSuccess.xml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,12 @@
33
<title>.ajaxSuccess()</title>
44
<signature>
55
<added>1.0</added>
6-
<argument name="handler(event, XMLHttpRequest, ajaxOptions)" type="Function">
6+
<argument name="handler" type="Function">
77
<desc>The function to be invoked.</desc>
8+
<argument name="event" type="Event" />
9+
<argument name="jqXHR" type="jqXHR" />
10+
<argument name="ajaxOptions" type="PlainObject" />
11+
<argument name="data" type="PlainObject" />
812
</argument>
913
</signature>
1014
<desc>Attach a function to be executed whenever an Ajax request completes successfully. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>

‎entries/append.xml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,15 @@
2020
</signature>
2121
<signature>
2222
<added>1.4</added>
23-
<argument name="function(index, html)" type="Function">
23+
<argument name="function" type="Function">
2424
<desc>A function that returns an HTML string, DOM element(s), or jQuery object to insert at the end of each element in the set of matched elements. Receives the index position of the element in the set and the old HTML value of the element as arguments. Within the function, <code>this</code> refers to the current element in the set.</desc>
25+
<argument name="index" type="Integer" />
26+
<argument name="html" type="String" />
27+
<return>
28+
<type name="htmlString"/>
29+
<type name="Element"/>
30+
<type name="jQuery"/>
31+
</return>
2532
</argument>
2633
</signature>
2734
<desc>Insert content, specified by the parameter, to the end of each element in the set of matched elements.</desc>

‎entries/attr.xml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,14 @@ The title of the emphasis is:<div></div>
164164
<argument name="attributeName" type="String">
165165
<desc>The name of the attribute to set.</desc>
166166
</argument>
167-
<argument name="function(index, attr)" type="Function">
167+
<argument name="function" type="Function">
168168
<desc>A function returning the value to set. <code>this</code> is the current element. Receives the index position of the element in the set and the old attribute value as arguments.</desc>
169+
<argument name="index" type="Integer" />
170+
<argument name="attr" type="String" />
171+
<return>
172+
<type name="String"/>
173+
<type name="Number"/>
174+
</return>
169175
</argument>
170176
</signature>
171177
<desc>Set one or more attributes for the set of matched elements.</desc>

‎entries/before.xml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@
2121
<signature>
2222
<added>1.4</added>
2323
<argument name="function" type="Function">
24+
<argument name="index" type="Integer" />
25+
<argument name="html" type="String" />
26+
<return>
27+
<type name="htmlString"/>
28+
<type name="Element"/>
29+
<type name="jQuery"/>
30+
</return>
2431
<desc>A function that returns an HTML string, DOM element(s), or jQuery object to insert before each element in the set of matched elements. Receives the index position of the element in the set as an argument. Within the function, <code>this</code> refers to the current element in the set.
2532
</desc>
2633
</argument>

‎entries/bind.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@
99
<argument name="eventData" type="Object" optional="true">
1010
<desc>An object containing data that will be passed to the event handler.</desc>
1111
</argument>
12-
<argument name="handler(eventObject)" type="Function">
12+
<argument name="handler" type="Function">
1313
<desc>A function to execute each time the event is triggered.</desc>
14+
<argument name="eventObject" type="Event" />
1415
</argument>
1516
</signature>
1617
<signature>

‎entries/blur.xml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,19 @@
44
<desc>Bind an event handler to the "blur" JavaScript event, or trigger that event on an element.</desc>
55
<signature>
66
<added>1.0</added>
7-
<argument name="handler(eventObject)" type="Function">
7+
<argument name="handler" type="Function">
88
<desc>A function to execute each time the event is triggered.</desc>
9+
<argument name="eventObject" type="Event" />
910
</argument>
1011
</signature>
1112
<signature>
1213
<added>1.4.3</added>
1314
<argument name="eventData" type="Object" optional="true">
1415
<desc>An object containing data that will be passed to the event handler.</desc>
1516
</argument>
16-
<argument name="handler(eventObject)" type="Function">
17+
<argument name="handler" type="Function">
1718
<desc>A function to execute each time the event is triggered.</desc>
19+
<argument name="eventObject" type="Event" />
1820
</argument>
1921
</signature>
2022
<signature>

‎entries/change.xml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,19 @@
44
<desc>Bind an event handler to the "change" JavaScript event, or trigger that event on an element.</desc>
55
<signature>
66
<added>1.0</added>
7-
<argument name="handler(eventObject)" type="Function">
7+
<argument name="handler" type="Function">
88
<desc>A function to execute each time the event is triggered.</desc>
9+
<argument name="eventObject" type="Event" />
910
</argument>
1011
</signature>
1112
<signature>
1213
<added>1.4.3</added>
1314
<argument name="eventData" type="Object" optional="true">
1415
<desc>An object containing data that will be passed to the event handler.</desc>
1516
</argument>
16-
<argument name="handler(eventObject)" type="Function">
17+
<argument name="handler" type="Function">
1718
<desc>A function to execute each time the event is triggered.</desc>
19+
<argument name="eventObject" type="Event" />
1820
</argument>
1921
</signature>
2022
<signature>

‎entries/click.xml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,19 @@
44
<desc>Bind an event handler to the "click" JavaScript event, or trigger that event on an element.</desc>
55
<signature>
66
<added>1.0</added>
7-
<argument name="handler(eventObject)" type="Function">
7+
<argument name="handler" type="Function">
88
<desc>A function to execute each time the event is triggered.</desc>
9+
<argument name="eventObject" type="Event" />
910
</argument>
1011
</signature>
1112
<signature>
1213
<added>1.4.3</added>
1314
<argument name="eventData" type="Object" optional="true">
1415
<desc>An object containing data that will be passed to the event handler.</desc>
1516
</argument>
16-
<argument name="handler(eventObject)" type="Function">
17+
<argument name="handler" type="Function">
1718
<desc>A function to execute each time the event is triggered.</desc>
19+
<argument name="eventObject" type="Event" />
1820
</argument>
1921
</signature>
2022
<signature>

‎entries/closest.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
</signature>
2020
<signature>
2121
<added>1.6</added>
22-
<argument name="jQuery object" type="jQuery">
22+
<argument name="selection" type="jQuery">
2323
<desc>A jQuery object to match elements against.</desc>
2424
</argument>
2525
</signature>

‎entries/css.xml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,8 +123,14 @@ $( "div" ).click(function() {
123123
<argument name="propertyName" type="String">
124124
<desc>A CSS property name.</desc>
125125
</argument>
126-
<argument name="function(index, value)" type="Function">
126+
<argument name="function" type="Function">
127127
<desc>A function returning the value to set. <code>this</code> is the current element. Receives the index position of the element in the set and the old value as arguments.</desc>
128+
<argument name="index" type="Integer" />
129+
<argument name="value" type="String" />
130+
<return>
131+
<type name="String"/>
132+
<type name="Number"/>
133+
</return>
128134
</argument>
129135
</signature>
130136
<signature>

‎entries/dblclick.xml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,19 @@
44
<desc>Bind an event handler to the "dblclick" JavaScript event, or trigger that event on an element.</desc>
55
<signature>
66
<added>1.0</added>
7-
<argument name="handler(eventObject)" type="Function">
7+
<argument name="handler" type="Function">
88
<desc>A function to execute each time the event is triggered.</desc>
9+
<argument name="eventObject" type="Event" />
910
</argument>
1011
</signature>
1112
<signature>
1213
<added>1.4.3</added>
1314
<argument name="eventData" type="Object" optional="true">
1415
<desc>An object containing data that will be passed to the event handler.</desc>
1516
</argument>
16-
<argument name="handler(eventObject)" type="Function">
17+
<argument name="handler" type="Function">
1718
<desc>A function to execute each time the event is triggered.</desc>
19+
<argument name="eventObject" type="Event" />
1820
</argument>
1921
</signature>
2022
<signature>

‎entries/delegate.xml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@
1010
<argument name="eventType" type="String">
1111
<desc>A string containing one or more space-separated JavaScript event types, such as "click" or "keydown," or custom event names.</desc>
1212
</argument>
13-
<argument name="handler(eventObject)" type="Function">
13+
<argument name="handler" type="Function">
1414
<desc>A function to execute at the time the event is triggered.</desc>
15+
<argument name="eventObject" type="Event" />
1516
</argument>
1617
</signature>
1718
<signature>
@@ -25,8 +26,9 @@
2526
<argument name="eventData" type="Object">
2627
<desc>An object containing data that will be passed to the event handler.</desc>
2728
</argument>
28-
<argument name="handler(eventObject)" type="Function">
29+
<argument name="handler" type="Function">
2930
<desc>A function to execute at the time the event is triggered.</desc>
31+
<argument name="eventObject" type="Event" />
3032
</argument>
3133
</signature>
3234
<signature>

‎entries/each.xml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
<title>.each()</title>
44
<signature>
55
<added>1.0</added>
6-
<argument name="function(index, Element)" type="Function">
6+
<argument name="function" type="Function">
77
<desc>A function to execute for each matched element.</desc>
8+
<argument name="index" type="Integer" />
9+
<argument name="element" type="Element" />
810
</argument>
911
</signature>
1012
<desc>Iterate over a jQuery object, executing a function for each matched element. </desc>

‎entries/eq-selector.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<signature>
1212
<sample>:eq(-index)</sample>
1313
<added>1.8</added>
14-
<argument name="-index" type="Integer">
14+
<argument name="indexFromEnd" type="Integer">
1515
<desc>Zero-based index of the element to match, counting backwards from the last element. </desc>
1616
</argument>
1717
</signature>

‎entries/eq.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
</signature>
1010
<signature>
1111
<added>1.4</added>
12-
<argument name="-index" type="Integer">
12+
<argument name="indexFromEnd" type="Integer">
1313
<desc>An integer indicating the position of the element, counting backwards from the last element in the set. </desc>
1414
</argument>
1515
</signature>

‎entries/error.xml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,19 @@
44
<desc>Bind an event handler to the "error" JavaScript event.</desc>
55
<signature>
66
<added>1.0</added>
7-
<argument name="handler(eventObject)" type="Function">
7+
<argument name="handler" type="Function">
88
<desc>A function to execute when the event is triggered.</desc>
9+
<argument name="eventObject" type="Event" />
910
</argument>
1011
</signature>
1112
<signature>
1213
<added>1.4.3</added>
1314
<argument name="eventData" type="Object" optional="true">
1415
<desc>An object containing data that will be passed to the event handler.</desc>
1516
</argument>
16-
<argument name="handler(eventObject)" type="Function">
17+
<argument name="handler" type="Function">
1718
<desc>A function to execute each time the event is triggered.</desc>
19+
<argument name="eventObject" type="Event" />
1820
</argument>
1921
</signature>
2022
<longdesc>

‎entries/filter.xml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,11 @@
99
</signature>
1010
<signature>
1111
<added>1.0</added>
12-
<argument name="function(index)" type="Function">
12+
<argument name="function" type="Function">
1313
<desc>A function used as a test for each element in the set. <code>this</code> is the current DOM element.</desc>
14+
<argument name="index" type="Integer" />
15+
<argument name="element" type="Element" />
16+
<return type="Boolean" />
1417
</argument>
1518
</signature>
1619
<signature>
@@ -21,7 +24,7 @@
2124
</signature>
2225
<signature>
2326
<added>1.4</added>
24-
<argument name="jQuery object" type="Object">
27+
<argument name="selection" type="jQuery">
2528
<desc>An existing jQuery object to match the current set of elements against.</desc>
2629
</argument>
2730
</signature>

‎entries/find.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
</signature>
1010
<signature>
1111
<added>1.6</added>
12-
<argument name="jQuery object" type="Object">
12+
<argument name="selection" type="jQuery">
1313
<desc>A jQuery object to match elements against.</desc>
1414
</argument>
1515
</signature>

0 commit comments

Comments
 (0)