Permalink
Browse files

Fix return type and elaborate for callbacks methods

  • Loading branch information...
1 parent 0dc8518 commit 082870287ef8d20cabb702ac413ac813d0e65ed1 @kswedberg kswedberg committed Sep 3, 2012
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry name="callbacks.add" type="method" return="undefined">
+<entry name="callbacks.add" type="method" return="Callbacks">
<title>callbacks.add()</title>
<signature>
<added>1.7</added>
@@ -9,6 +9,7 @@
</signature>
<desc>Add a callback or a collection of callbacks to a callback list.</desc>
<longdesc>
+ <p>This method returns the Callbacks object onto which it is attached (<code>this</code>). </p>
<h2 id="example-1">Example</h2>
<p>Using <code>callbacks.add()</code> to add new callbacks to a callback list:</p>
<pre><code>
@@ -45,4 +46,4 @@ callbacks.fire( 'world' );
</longdesc>
<category slug="callbacks-object"/>
<category slug="version/1.7"/>
-</entry>
+</entry>
@@ -1,11 +1,12 @@
<?xml version="1.0"?>
-<entry name="callbacks.disable" type="method" return="undefined">
+<entry name="callbacks.disable" type="method" return="Callbacks">
<title>callbacks.disable()</title>
<signature>
<added>1.7</added>
</signature>
<desc>Disable a callback list from doing anything more.</desc>
<longdesc>
+ <p>This method returns the Callbacks object onto which it is attached (<code>this</code>). </p>
<h2 id="example-1">Example</h2>
<p>Using <code>callbacks.disable()</code> to disable further calls being made to a callback list:</p>
<pre><code>
@@ -31,4 +32,4 @@ callbacks.fire( 'foobar' ); // foobar isn't output
</longdesc>
<category slug="callbacks-object"/>
<category slug="version/1.7"/>
-</entry>
+</entry>
@@ -1,11 +1,12 @@
<?xml version="1.0"?>
-<entry name="callbacks.empty" type="method" return="undefined">
+<entry name="callbacks.empty" type="method" return="Callbacks">
<title>callbacks.empty()</title>
<signature>
<added>1.7</added>
</signature>
<desc>Remove all of the callbacks from a list.</desc>
<longdesc>
+ <p>This method returns the Callbacks object onto which it is attached (<code>this</code>). </p>
<h2 id="example-1">Example</h2>
<p>Using <code>callbacks.empty()</code> to empty a list of callbacks:</p>
<pre><code>
@@ -35,4 +36,4 @@ console.log( callbacks.has( bar ) ); // false
</longdesc>
<category slug="callbacks-object"/>
<category slug="version/1.7"/>
-</entry>
+</entry>
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry name="callbacks.fire" type="method" return="undefined">
+<entry name="callbacks.fire" type="method" return="Callbacks">
<title>callbacks.fire()</title>
<signature>
<added>1.7</added>
@@ -9,6 +9,7 @@
</signature>
<desc>Call all of the callbacks with the given arguments</desc>
<longdesc>
+ <p>This method returns the Callbacks object onto which it is attached (<code>this</code>). </p>
<h2 id="example-1">Example</h2>
<p>Using <code>callbacks.fire()</code> to invoke the callbacks in a list with any arguments that have been passed:</p>
<pre><code>
@@ -43,4 +44,4 @@ callbacks.fire( 'hello again' );
</longdesc>
<category slug="callbacks-object"/>
<category slug="version/1.7"/>
-</entry>
+</entry>
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry name="callbacks.fireWith" type="method" return="undefined">
+<entry name="callbacks.fireWith" type="method" return="Callbacks">
<title>callbacks.fireWith()</title>
<signature>
<added>1.7</added>
@@ -12,6 +12,7 @@
</signature>
<desc>Call all callbacks in a list with the given context and arguments.</desc>
<longdesc>
+ <p>This method returns the Callbacks object onto which it is attached (<code>this</code>). </p>
<h2 id="example-1">Example</h2>
<p>Using <code>callbacks.fireWith()</code> to fire a list of callbacks with a specific context and an array of arguments:</p>
<pre><code>
@@ -35,4 +36,4 @@ callbacks.fireWith( window, ['foo','bar']);
</longdesc>
<category slug="callbacks-object"/>
<category slug="version/1.7"/>
-</entry>
+</entry>
@@ -1,11 +1,13 @@
<?xml version="1.0"?>
-<entry name="callbacks.lock" type="method" return="undefined">
+<entry name="callbacks.lock" type="method" return="Callbacks">
<title>callbacks.lock()</title>
<signature>
<added>1.7</added>
</signature>
<desc>Lock a callback list in its current state.</desc>
- <longdesc/>
+ <longdesc>
+ <p>This method returns the Callbacks object onto which it is attached (<code>this</code>). </p>
+ </longdesc>
<example>
<desc>Using <code>callbacks.lock()</code> to lock a callback list to avoid further changes being made to the list state:</desc>
<code><![CDATA[// a sample logging function to be added to a callbacks list
@@ -34,4 +36,4 @@ callbacks.fire( 'world' );
</example>
<category slug="callbacks-object"/>
<category slug="version/1.7"/>
-</entry>
+</entry>
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<entry name="callbacks.remove" type="method" return="undefined">
+<entry name="callbacks.remove" type="method" return="Callbacks">
<title>callbacks.remove()</title>
<signature>
<added>1.7</added>
@@ -8,7 +8,9 @@
</argument>
</signature>
<desc>Remove a callback or a collection of callbacks from a callback list.</desc>
- <longdesc/>
+ <longdesc>
+ <p>This method returns the Callbacks object onto which it is attached (<code>this</code>). </p>
+ </longdesc>
<example>
<desc>Using <code>callbacks.remove()</code> to remove callbacks from a callback list:</desc>
<code><![CDATA[// a sample logging function to be added to a callbacks list
@@ -35,4 +37,4 @@ callbacks.fire( 'world' );
</example>
<category slug="callbacks-object"/>
<category slug="version/1.7"/>
-</entry>
+</entry>

0 comments on commit 0828702

Please sign in to comment.