Skip to content
Prev Previous commit
Next Next commit
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.
  • Loading branch information
esx committed Jan 18, 2014
commit 0d7d9b303f46db2ffb00d336e1a0fd20eec02fd8
4 changes: 2 additions & 2 deletions entries/ajaxComplete.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
<added>1.0</added>
<argument name="handler" type="Function">
<argument name="event" type="Event" />
<argument name="jsXHR" type="jsXHR" />
<argument name="ajaxOptions" type="ajaxOptions" />
<argument name="jqXHR" type="jqXHR" />
<argument name="ajaxOptions" type="PlainObject" />
<desc>The function to be invoked.</desc>
</argument>
</signature>
Expand Down
2 changes: 1 addition & 1 deletion entries/ajaxError.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<desc>The function to be invoked.</desc>
<argument name="event" type="Event" />
<argument name="jqXHR" type="jqXHR" />
<argument name="ajaxSettings" type="ajaxSettings" />
<argument name="ajaxSettings" type="PlainObject" />
<argument name="thrownError" type="Error" />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no Error object on the Types page. Also I got a String for this argument.

</argument>
</signature>
Expand Down
2 changes: 1 addition & 1 deletion entries/ajaxSend.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<desc>The function to be invoked.</desc>
<argument name="event" type="Event" />
<argument name="jqXHR" type="jqXHR" />
<argument name="ajaxOptions" type="ajaxOptions" />
<argument name="ajaxOptions" type="PlainObject" />
</argument>
</signature>
<desc>Attach a function to be executed before an Ajax request is sent. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
Expand Down
4 changes: 2 additions & 2 deletions entries/ajaxSuccess.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
<argument name="handler" type="Function">
<desc>The function to be invoked.</desc>
<argument name="event" type="Event" />
<argument name="jsXHR" type="jsXHR" />
<argument name="ajaxOptions" type="ajaxOptions" />
<argument name="jqXHR" type="jqXHR" />
<argument name="ajaxOptions" type="PlainObject" />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe there's a fourth argument here that has the results of the call.

</argument>
</signature>
<desc>Attach a function to be executed whenever an Ajax request completes successfully. This is an <a href="/Ajax_Events/">Ajax Event</a>.</desc>
Expand Down
4 changes: 2 additions & 2 deletions entries/jQuery.ajaxPrefilter.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
</argument>
<argument name="handler" type="Function">
<desc>A handler to set default values for future Ajax requests.</desc>
<argument name="options" type="ajaxOptions" />
<argument name="originalOptions" type="ajaxOptions" />
<argument name="options" type="PlainObject" />
<argument name="originalOptions" type="PlainObject" />
<argument name="jqXHR" type="jqXHR" />
</argument>
</signature>
Expand Down
4 changes: 2 additions & 2 deletions entries/jQuery.ajaxTransport.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
</argument>
<argument name="handler" type="Function">
<desc>A handler to return the new transport object to use with the data type provided in the first argument.</desc>
<argument name="options" type="ajaxOptions" />
<argument name="originalOptions" type="ajaxOptions" />
<argument name="options" type="PlainObject" />
<argument name="originalOptions" type="PlainObject" />
<argument name="jqXHR" type="jqXHR" />
</argument>
</signature>
Expand Down
2 changes: 1 addition & 1 deletion entries/load.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<argument name="complete" type="Function" optional="true">
<argument name="responseText" type="String" />
<argument name="textStatus" type="String"/>
<argument name="jsXHR" type="jsXHR"/>
<argument name="jqXHR" type="jqXHR"/>
<desc>A callback function that is executed when the request completes.</desc>
</argument>
</signature>
Expand Down