Skip to content

Commit 0828702

Browse files
committed
Fix return type and elaborate for callbacks methods
1 parent 0dc8518 commit 0828702

File tree

7 files changed

+25
-16
lines changed

7 files changed

+25
-16
lines changed

entries/callbacks.add.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0"?>
2-
<entry name="callbacks.add" type="method" return="undefined">
2+
<entry name="callbacks.add" type="method" return="Callbacks">
33
<title>callbacks.add()</title>
44
<signature>
55
<added>1.7</added>
@@ -9,6 +9,7 @@
99
</signature>
1010
<desc>Add a callback or a collection of callbacks to a callback list.</desc>
1111
<longdesc>
12+
<p>This method returns the Callbacks object onto which it is attached (<code>this</code>). </p>
1213
<h2 id="example-1">Example</h2>
1314
<p>Using <code>callbacks.add()</code> to add new callbacks to a callback list:</p>
1415
<pre><code>
@@ -45,4 +46,4 @@ callbacks.fire( 'world' );
4546
</longdesc>
4647
<category slug="callbacks-object"/>
4748
<category slug="version/1.7"/>
48-
</entry>
49+
</entry>

entries/callbacks.disable.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
<?xml version="1.0"?>
2-
<entry name="callbacks.disable" type="method" return="undefined">
2+
<entry name="callbacks.disable" type="method" return="Callbacks">
33
<title>callbacks.disable()</title>
44
<signature>
55
<added>1.7</added>
66
</signature>
77
<desc>Disable a callback list from doing anything more.</desc>
88
<longdesc>
9+
<p>This method returns the Callbacks object onto which it is attached (<code>this</code>). </p>
910
<h2 id="example-1">Example</h2>
1011
<p>Using <code>callbacks.disable()</code> to disable further calls being made to a callback list:</p>
1112
<pre><code>
@@ -31,4 +32,4 @@ callbacks.fire( 'foobar' ); // foobar isn't output
3132
</longdesc>
3233
<category slug="callbacks-object"/>
3334
<category slug="version/1.7"/>
34-
</entry>
35+
</entry>

entries/callbacks.empty.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
<?xml version="1.0"?>
2-
<entry name="callbacks.empty" type="method" return="undefined">
2+
<entry name="callbacks.empty" type="method" return="Callbacks">
33
<title>callbacks.empty()</title>
44
<signature>
55
<added>1.7</added>
66
</signature>
77
<desc>Remove all of the callbacks from a list.</desc>
88
<longdesc>
9+
<p>This method returns the Callbacks object onto which it is attached (<code>this</code>). </p>
910
<h2 id="example-1">Example</h2>
1011
<p>Using <code>callbacks.empty()</code> to empty a list of callbacks:</p>
1112
<pre><code>
@@ -35,4 +36,4 @@ console.log( callbacks.has( bar ) ); // false
3536
</longdesc>
3637
<category slug="callbacks-object"/>
3738
<category slug="version/1.7"/>
38-
</entry>
39+
</entry>

entries/callbacks.fire.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0"?>
2-
<entry name="callbacks.fire" type="method" return="undefined">
2+
<entry name="callbacks.fire" type="method" return="Callbacks">
33
<title>callbacks.fire()</title>
44
<signature>
55
<added>1.7</added>
@@ -9,6 +9,7 @@
99
</signature>
1010
<desc>Call all of the callbacks with the given arguments</desc>
1111
<longdesc>
12+
<p>This method returns the Callbacks object onto which it is attached (<code>this</code>). </p>
1213
<h2 id="example-1">Example</h2>
1314
<p>Using <code>callbacks.fire()</code> to invoke the callbacks in a list with any arguments that have been passed:</p>
1415
<pre><code>
@@ -43,4 +44,4 @@ callbacks.fire( 'hello again' );
4344
</longdesc>
4445
<category slug="callbacks-object"/>
4546
<category slug="version/1.7"/>
46-
</entry>
47+
</entry>

entries/callbacks.fireWith.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0"?>
2-
<entry name="callbacks.fireWith" type="method" return="undefined">
2+
<entry name="callbacks.fireWith" type="method" return="Callbacks">
33
<title>callbacks.fireWith()</title>
44
<signature>
55
<added>1.7</added>
@@ -12,6 +12,7 @@
1212
</signature>
1313
<desc>Call all callbacks in a list with the given context and arguments.</desc>
1414
<longdesc>
15+
<p>This method returns the Callbacks object onto which it is attached (<code>this</code>). </p>
1516
<h2 id="example-1">Example</h2>
1617
<p>Using <code>callbacks.fireWith()</code> to fire a list of callbacks with a specific context and an array of arguments:</p>
1718
<pre><code>
@@ -35,4 +36,4 @@ callbacks.fireWith( window, ['foo','bar']);
3536
</longdesc>
3637
<category slug="callbacks-object"/>
3738
<category slug="version/1.7"/>
38-
</entry>
39+
</entry>

entries/callbacks.lock.xml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
<?xml version="1.0"?>
2-
<entry name="callbacks.lock" type="method" return="undefined">
2+
<entry name="callbacks.lock" type="method" return="Callbacks">
33
<title>callbacks.lock()</title>
44
<signature>
55
<added>1.7</added>
66
</signature>
77
<desc>Lock a callback list in its current state.</desc>
8-
<longdesc/>
8+
<longdesc>
9+
<p>This method returns the Callbacks object onto which it is attached (<code>this</code>). </p>
10+
</longdesc>
911
<example>
1012
<desc>Using <code>callbacks.lock()</code> to lock a callback list to avoid further changes being made to the list state:</desc>
1113
<code><![CDATA[// a sample logging function to be added to a callbacks list
@@ -34,4 +36,4 @@ callbacks.fire( 'world' );
3436
</example>
3537
<category slug="callbacks-object"/>
3638
<category slug="version/1.7"/>
37-
</entry>
39+
</entry>

entries/callbacks.remove.xml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0"?>
2-
<entry name="callbacks.remove" type="method" return="undefined">
2+
<entry name="callbacks.remove" type="method" return="Callbacks">
33
<title>callbacks.remove()</title>
44
<signature>
55
<added>1.7</added>
@@ -8,7 +8,9 @@
88
</argument>
99
</signature>
1010
<desc>Remove a callback or a collection of callbacks from a callback list.</desc>
11-
<longdesc/>
11+
<longdesc>
12+
<p>This method returns the Callbacks object onto which it is attached (<code>this</code>). </p>
13+
</longdesc>
1214
<example>
1315
<desc>Using <code>callbacks.remove()</code> to remove callbacks from a callback list:</desc>
1416
<code><![CDATA[// a sample logging function to be added to a callbacks list
@@ -35,4 +37,4 @@ callbacks.fire( 'world' );
3537
</example>
3638
<category slug="callbacks-object"/>
3739
<category slug="version/1.7"/>
38-
</entry>
40+
</entry>

0 commit comments

Comments
 (0)