Skip to content

Correct documentation of callback arguments #580

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Correct documentation of callback arguments #580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76e8402
after(): Document new callback signature
jugglinmike Oct 27, 2014
82ebb27
before(): Document new callback signature
jugglinmike Oct 27, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion entries/after.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,25 @@
<argument name="function" type="Function">
<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>
<argument name="index" type="Integer" />
<argument name="html" type="String" />
<return>
<type name="htmlString"/>
<type name="Element"/>
<type name="jQuery"/>
</return>
</argument>
</signature>
<signature>
<added>1.10</added>
<argument name="function" type="Function">
<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 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>
<argument name="index" type="Integer" />
<argument name="html" type="String" />
<return>
<type name="htmlString"/>
<type name="Element"/>
<type name="jQuery"/>
</return>
</argument>
</signature>
<desc>Insert content, specified by the parameter, after each element in the set of matched elements.</desc>
<longdesc>
Expand Down
15 changes: 14 additions & 1 deletion entries/before.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
<added>1.4</added>
<argument name="function" type="Function">
<argument name="index" type="Integer" />
<argument name="html" type="String" />
<return>
<type name="htmlString"/>
<type name="Element"/>
Expand All @@ -31,6 +30,20 @@
<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.
</desc>
</argument>
</signature>
<signature>
<added>1.10</added>
<argument name="function" type="Function">
<argument name="index" type="Integer" />
<argument name="html" type="String" />
<return>
<type name="htmlString"/>
<type name="Element"/>
<type name="jQuery"/>
</return>
<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 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>
</argument>
</signature>
<desc>Insert content, specified by the parameter, before each element in the set of matched elements.</desc>
<longdesc>
Expand Down