Skip to content

Commit 6aa5119

Browse files
committed
Some fixies in signatures
Some fixes to add missing parameters and naming consistency for callback signatures, based on code review by tjvantoll.
1 parent 41ce261 commit 6aa5119

File tree

10 files changed

+12
-6
lines changed

10 files changed

+12
-6
lines changed

entries/addClass.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<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>
1414
<argument name="index" type="Integer" />
15-
<argument name="currentClass" type="String" />
15+
<argument name="currentClassName" type="String" />
1616
<return type="String"/>
1717
</argument>
1818
</signature>

entries/after.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
<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>
2525
<argument name="index" type="Integer" />
26+
<argument name="html" type="String" />
2627
<return>
2728
<type name="htmlString"/>
2829
<type name="Element"/>

entries/ajaxError.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<argument name="event" type="Event" />
99
<argument name="jqXHR" type="jqXHR" />
1010
<argument name="ajaxSettings" type="PlainObject" />
11-
<argument name="thrownError" type="Error" />
11+
<argument name="thrownError" type="String" />
1212
</argument>
1313
</signature>
1414
<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/ajaxSuccess.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
<desc>The function to be invoked.</desc>
88
<argument name="event" type="Event" />
99
<argument name="jqXHR" type="jqXHR" />
10-
<argument name="ajaxOptions" type="PlainObject" />
10+
<argument name="ajaxOptions" type="PlainObject" />
11+
<argument name="data" type="PlainObject" />
1112
</argument>
1213
</signature>
1314
<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/before.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
<added>1.4</added>
2323
<argument name="function" type="Function">
2424
<argument name="index" type="Integer" />
25+
<argument name="html" type="String" />
2526
<return>
2627
<type name="htmlString"/>
2728
<type name="Element"/>

entries/filter.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
<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>
1414
<argument name="index" type="Integer" />
15+
<argument name="element" type="Element" />
1516
<return type="Boolean" />
1617
</argument>
1718
</signature>

entries/is.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@
1010
<signature>
1111
<added>1.6</added>
1212
<argument name="function" type="Function">
13-
<desc>A function used as a test for the set of elements. It accepts one argument, <code>index</code>, which is the element's index in the jQuery collection.Within the function, <code>this</code> refers to the current DOM element. </desc>
13+
<desc>A function used as a test for the set of elements. It accepts one argument, <code>index</code>, which is the element's index in the jQuery collection. Within the function, <code>this</code> refers to the current DOM element. </desc>
1414
<argument name="index" type="Integer" />
15+
<argument name="element" type="Element" />
1516
<return type="Boolean" />
1617
</argument>
1718
</signature>

entries/not.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
<argument name="function" type="Function">
1919
<desc>A function used as a test for each element in the set. <code>this</code> is the current DOM element.</desc>
2020
<argument name="index" type="Integer" />
21+
<argument name="element" type="Element" />
2122
<return type="Boolean" />
2223
</argument>
2324
</signature>

entries/removeClass.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<added>1.4</added>
1212
<argument name="function" type="Function">
1313
<argument name="index" type="Integer" />
14-
<argument name="class" type="String" />
14+
<argument name="className" type="String" />
1515
<return type="String" />
1616
<desc>A function returning one or more space-separated class names to be removed. Receives the index position of the element in the set and the old class value as arguments.</desc>
1717
</argument>

entries/toggleClass.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
<added>1.4</added>
2727
<argument name="function" type="Function">
2828
<argument name="index" type="Integer" />
29-
<argument name="class" type="String" />
29+
<argument name="className" type="String" />
3030
<argument name="switch" type="Boolean" />
3131
<return type="String" />
3232
<desc>A function that returns class names to be toggled in the class attribute of each element in the matched set. Receives the index position of the element in the set, the old class value, and the switch as arguments.</desc>

0 commit comments

Comments
 (0)