Bug 569708 - convert timer.md to apidocs format. r=adw, a=myk
authorNoelle Murata <fiveinchpixie@gmail.com>
Wed, 18 Aug 2010 16:42:01 -0700
changeset 734 cfa13d9472737e6132b9e67eae2353f777702c15
parent 733 fe005b3aff5aef1c7bd24e2aed4adfbd0f05ec8e
child 735 5ba38bd91643e5345ea2b2bb42edb001552a4ed2
push id265
push userdwillcoxon@mozilla.com
push dateWed, 18 Aug 2010 23:42:39 +0000
reviewersadw, myk
bugs569708
Bug 569708 - convert timer.md to apidocs format. r=adw, a=myk
packages/jetpack-core/docs/timer.md
--- a/packages/jetpack-core/docs/timer.md
+++ b/packages/jetpack-core/docs/timer.md
@@ -1,24 +1,44 @@
+<!-- contributed by Drew Willcoxon [adw@mozilla.com]  -->
+<!-- contributed by Atul Varma [atul@mozilla.com]  -->
+<!-- edited by Noelle Murata [fiveinchpixie@gmail.com]  -->
+
 The `timer` module provides access to web-like timing functionality.
 
-<code>timer.**setInterval**(*callback*, *ms*)</code>
-
-Schedules *callback* to be called repeatedly every *ms* milliseconds.
-Returns an integer ID that should later be used to unschedule the
-callback.
-
-<code>timer.**clearInterval**(*id*)</code>
-
-Given an integer ID returned from `setInterval()`,
-prevents the callback with the ID from being called again.
+<api name="setTimeout">
+@method
+  Schedules `callback` to be called in `ms` milliseconds.
+@returns {integer}
+  An ID that can later be used to undo this scheduling, if `callback` hasn't yet
+  been called.
+@param callback {function}
+  Function to be called.
+@param ms {integer}
+  Interval in milliseconds after which the function will be called.
+</api>
 
-<code>timer.**setTimeout**(*callback*, *ms*)</code>
-
-Schedules *callback* to be called in *ms* milliseconds. Returns an
-integer ID that can later be used to undo this scheduling, if
-*callback* hasn't yet been called.
+<api name="clearTimeout">
+@method
+  Given an ID returned from `setTimeout()`, prevents the callback with the ID
+  from being called (if it hasn't yet been called).
+@param ID {integer}
+  An ID returned from `setTimeout()`.
+</api>
 
-<code>timer.**clearTimeout**(*id*)</code>
+<api name="setInterval">
+@method
+  Schedules `callback` to be called repeatedly every `ms` milliseconds.
+@returns {integer}
+  An ID that can later be used to unschedule the callback.
+@param callback {callback}
+  Function to be called.
+@param ms {integer}
+  Interval in milliseconds at which the function will be called.
+</api>
 
-Given an integer ID returned from `setTimeout()`, prevents
-the callback with the ID from being called (if it hasn't yet been
-called).
+<api name="clearInterval">
+@method
+  Given an ID returned from `setInterval()`, prevents the callback with the ID
+  from being called again.
+@param ID {integer}
+  An ID returned from `setInterval()`.
+</api>