Tweaked annyang.removeCallback() documentation

TalAter · Jan 27, 2016 · 84936f6 · 84936f6
1 parent 74bb656
commit 84936f6
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 17 deletions.
diff --git a/annyang.js b/annyang.js
@@ -481,14 +481,17 @@
  * annyang.addCallback('end', myFunction1);
  * annyang.addCallback('end', myFunction2);
  *
- * // Remove myFunction2 from being called on start:
- * annyang.removeCallback('start', myFunction2);
+ * // Remove all callbacks from all events:
+ * annyang.removeCallback();
  *
  * // Remove all callbacks attached to end event:
  * annyang.removeCallback('end');
  *
- * // Remove all callbacks from all events:
- * annyang.removeCallback();
+ * // Remove myFunction2 from being called on start:
+ * annyang.removeCallback('start', myFunction2);
+ *
+ * // Remove myFunction1 from being called on all events:
+ * annyang.removeCallback(undefined, myFunction1);
  * ````
  *
  * @param type Name of event type to remove callback from

diff --git a/docs/README.md b/docs/README.md
@@ -198,14 +198,17 @@ annyang.addCallback('start', myFunction2);
 annyang.addCallback('end', myFunction1);
 annyang.addCallback('end', myFunction2);
 
-// Remove myFunction2 from being called on start:
-annyang.removeCallback('start', myFunction2);
+// Remove all callbacks from all events:
+annyang.removeCallback();
 
 // Remove all callbacks attached to end event:
 annyang.removeCallback('end');
 
-// Remove all callbacks from all events:
-annyang.removeCallback();
+// Remove myFunction2 from being called on start:
+annyang.removeCallback('start', myFunction2);
+
+// Remove myFunction1 from being called on all events:
+annyang.removeCallback(undefined, myFunction1);
 ````
 
 ### Params:

diff --git a/test/coverage/__root__/annyang.js.html b/test/coverage/__root__/annyang.js.html
@@ -755,7 +755,10 @@ <h1>
 710
 711
 712
-713</td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+713
+714
+715
+716</td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -1254,6 +1257,9 @@ <h1>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">7×</span>
 <span class="cline-any cline-yes">11×</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -1950,14 +1956,17 @@ <h1>
  * annyang.addCallback('end', myFunction1);
  * annyang.addCallback('end', myFunction2);
  *
- * // Remove myFunction2 from being called on start:
- * annyang.removeCallback('start', myFunction2);
+ * // Remove all callbacks from all events:
+ * annyang.removeCallback();
  *
  * // Remove all callbacks attached to end event:
  * annyang.removeCallback('end');
  *
- * // Remove all callbacks from all events:
- * annyang.removeCallback();
+ * // Remove myFunction2 from being called on start:
+ * annyang.removeCallback('start', myFunction2);
+ *
+ * // Remove myFunction1 from being called on all events:
+ * annyang.removeCallback(undefined, myFunction1);
  * ````
  *
  * @param type Name of event type to remove callback from
@@ -2185,7 +2194,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
  Code coverage
- generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Wed Jan 27 2016 10:00:40 GMT+0200 (IST)
+ generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Wed Jan 27 2016 10:04:49 GMT+0200 (IST)
 </div>
 </div>
 <script src="../prettify.js"></script>

diff --git a/test/coverage/__root__/index.html b/test/coverage/__root__/index.html
@@ -77,7 +77,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
  Code coverage
- generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Wed Jan 27 2016 10:00:40 GMT+0200 (IST)
+ generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Wed Jan 27 2016 10:04:49 GMT+0200 (IST)
 </div>
 </div>
 <script src="../prettify.js"></script>

diff --git a/test/coverage/coverage.json b/test/coverage/coverage.json
diff --git a/test/coverage/index.html b/test/coverage/index.html
@@ -77,7 +77,7 @@ <h1>
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
  Code coverage
- generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Wed Jan 27 2016 10:00:40 GMT+0200 (IST)
+ generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Wed Jan 27 2016 10:04:49 GMT+0200 (IST)
 </div>
 </div>
 <script src="prettify.js"></script>