Permalink
Browse files

jsdoc fixes

  • Loading branch information...
1 parent 8c77279 commit 1757ca75833d85e133510b9c3b074dbd9816f25d @olegp committed Sep 1, 2011
Showing with 328 additions and 425 deletions.
  1. +6 −0 lib/all.js
  2. +96 −153 lib/binary.js
  3. +73 −61 lib/console.js
  4. +35 −67 lib/fs-base.js
  5. +25 −20 lib/global.js
  6. +10 −18 lib/httpclient.js
  7. +36 −50 lib/io.js
  8. +4 −7 lib/jsgi.js
  9. +7 −2 lib/run.js
  10. +25 −31 lib/subprocess.js
  11. +9 −13 lib/system.js
  12. +2 −3 lib/test.js
View
@@ -1,3 +1,9 @@
+/**
+ * @fileoverview Collection of all modules.
+ */
+
+//TODO include example in docs
+
var modules = ['assert', 'binary', 'fs-base', 'httpclient', 'io', 'jsgi',
'system', 'test', 'global', 'run'];
View

Large diffs are not rendered by default.

Oops, something went wrong.
View
@@ -1,80 +1,92 @@
/**
-* @fileOverview This module provides a familiar console object for
-* logging and debugging.
-*/
+ * @fileOverview This module provides a familiar console object for logging and
+ * debugging defined in [CommonJS
+ * Console/A](http://wiki.commonjs.org/wiki/Console)
+ */
/**
-* Logs a message to the console.
-*
-* The first argument to log may be a string containing printf-like placeholders.
-* Otherwise, multipel arguments will be concatenated separated by spaces.
-* @param msg... one or more message arguments
-*
-* @name log
-*/
+ * Logs a message to the console.
+ *
+ * The first argument to log may be a string containing printf-like
+ * placeholders. Otherwise, multipel arguments will be concatenated separated by
+ * spaces.
+ *
+ * @param msg... one or more message arguments
+ *
+ * @name log
+ */
/**
-* Logs a message with the visual "error" representation, including the file name
-* and line number of the calling code.
-* @param msg... one or more message arguments
-* @function
-*
-* @name error
-*/
+ * Logs a message with the visual "error" representation, including the file
+ * name and line number of the calling code.
+ *
+ * @param msg... one or more message arguments
+ * @function
+ *
+ * @name error
+ */
/**
-* Logs a message with the visual "warn" representation, including the file name
-* and line number of the calling code.
-* @param msg... one or more message arguments
-* @function
-*
-* @name warn
-*/
+ * Logs a message with the visual "warn" representation, including the file name
+ * and line number of the calling code.
+ *
+ * @param msg... one or more message arguments
+ * @function
+ *
+ * @name warn
+ */
/**
-* Logs a message with the visual "info" representation, including the file name
-* and line number of the calling code.
-* @param {...} msg... one or more message arguments
-* @function
-*
-* @name info
-*/
+ * Logs a message with the visual "info" representation, including the file name
+ * and line number of the calling code.
+ *
+ * @param {...} msg... one or more message arguments
+ * @function
+ *
+ * @name info
+ */
/**
-* Prints a stack trace of JavaScript execution at the point where it is called.
-* @param {...} msg... optional message arguments
-* @function
-*
-* @name trace
-*/
+ * Prints a stack trace of JavaScript execution at the point where it is called.
+ *
+ * @param {...} msg... optional message arguments
+ * @function
+ *
+ * @name trace
+ */
/**
-* Tests that an expression is true and throws an exception if not.
-* @param expression the expression to test
-* @param {...} msg... one or more error messages
-* @function
-*
-* @name assert
-*/
+ * Tests that an expression is true and throws an exception if not.
+ *
+ * @param expression the expression to test
+ * @param {...} msg... one or more error messages
+ * @function
+ *
+ * @name assert
+ */
/**
-* Creates a new timer under the given name. Call `console.timeEnd(name)` with
-* the same name to stop the timer and log the time elapsed.
-* @param {String} name the timer name
-*
-* @name time
-*/
+ * Creates a new timer under the given name. Call `console.timeEnd(name)` with
+ * the same name to stop the timer and log the time elapsed.
+ *
+ * @param {String} name the timer name
+ *
+ * @name time
+ */
/**
-* Stops a timer created by a call to `console.time(name)` and logs the time elapsed.
-* @param {String} name the timer name
-*
-* @name timeEnd
-*/
+ * Stops a timer created by a call to `console.time(name)` and logs the time
+ * elapsed.
+ *
+ * @param {String} name the timer name
+ *
+ * @name timeEnd
+ */
/**
-* Prints a list of all properties of an object.
-* @param {Object} obj the object
-*
-* @name dir
-*/
+ * Prints a list of all properties of an object.
+ *
+ * @param {Object} obj the object
+ *
+ * @name dir
+ */
Oops, something went wrong.

0 comments on commit 1757ca7

Please sign in to comment.