tidy comments

Author: 75lb

lib/conf.json lib/default-conf.jsonlib/conf.json renamed to lib/default-conf.json

@@ -12,74 +12,76 @@ const cliOptions = require('./cli-options')
 const os = require('os')
 
 /**
-Exports a single function to parse jsdoc data.
-@module jsdoc-parse
-@example
-```js
-var parse = require("jsdoc-parse")
-```
-*/
+ * Exports a single function to parse jsdoc data.
+ * @module jsdoc-parse
+ * @example
+ * ```js
+ * var parse = require("jsdoc-parse")
+ * ```
+ */
 module.exports = jsdocParse
+jsdocParse.cliOptions = cliOptions.definitions
 
 /**
-@class
-@classdesc All options for jsdoc-parse, including defaults
-*/
-function ParseOptions () {
-  /**
-  * A list of javascript source files (or glob expressions) to parse for documentation. If this option is not set jsdoc-parse will wait for source code on stdin (i.e. `cat *.js | jsdoc-parse <options>`).
-  * @type {string | string[]}
-  * @example
-  * var parse = require("jsdoc-parse")
-  * var fs = require("fs")
-  *
-  * // either supply one or more file names
-  * parse({ src: "example.js" }).pipe(process.stdout)
-  *
-  * // or pipe in source code
-  * fs.createReadStream("example.js").parse().pipe(process.stdout)
-  */
-  this.src = null
+ * All options for jsdoc-parse, including defaults
+ */
+class ParseOptions {
+  constructor () {
+    /**
+     * A list of javascript source files (or glob expressions) to parse for documentation. If this  option is not set jsdoc-parse will wait for source code on stdin (i.e. `cat *.js | jsdoc-parse  <options>`).
+     * @type {string | string[]}
+     * @example
+     * var parse = require("jsdoc-parse")
+     * var fs = require("fs")
+     *
+     * // either supply one or more file names
+     * parse({ src: "example.js" }).pipe(process.stdout)
+     *
+     * // or pipe in source code
+     * fs.createReadStream("example.js").parse().pipe(process.stdout)
+     */
+    this.src = null
 
-  /**
-  Include identifier documentation marked as `@private` in the output
-  @type {boolean}
-  @default
-  */
-  this.private = false
+    /**
+     * Include identifier documentation marked as `@private` in the output
+     * @type {boolean}
+     * @default
+     */
+    this.private = false
 
-  /**
-  Print a few stats about the doclets parsed
-  @type {boolean}
-  */
-  this.stats
+    /**
+     * Print a few stats about the doclets parsed
+     * @type {boolean}
+     */
+    this.stats
 
-  /**
-  Enable experimental parsing of .html files.
-  @type {boolean}
-  @default
-  */
-  this.html = false
+    /**
+     * Enable experimental parsing of .html files.
+     * @type {boolean}
+     * @default
+     */
+    this.html = false
 
-  /**
-  Sort by one of more fields, e.g. `--sort-by kind category`. Pass the special value `none` to remove the default sort order.
-  @member module:jsdoc-parse~ParseOptions#sort-by
-  @type {array}
-  @default
-  */
-  this['sort-by'] = [ 'scope', 'category', 'kind', 'order' ]
+    /**
+     * Sort by one of more fields, e.g. `--sort-by kind category`. Pass the special value `none` to  * remove the default sort order.
+     * @member module:jsdoc-parse~ParseOptions#sort-by
+     * @type {array}
+     * @default
+     */
+    this['sort-by'] = [ 'scope', 'category', 'kind', 'order' ]
+  }
 }
 
 /**
-Documented javascript source in, documentation JSON out.
-@alias module:jsdoc-parse
-@param [options] {module:jsdoc-parse~ParseOptions} - parse options
-@returns {external:TransformStream}
-@example
-```js
-parse({ src:"lib/jsdoc-parse.js" }).pipe(process.stdout)
-```
-*/
+ * Documented javascript source in, documentation JSON out.
+ * @alias module:jsdoc-parse
+ * @param [options] {module:jsdoc-parse~ParseOptions} - parse options
+ * @returns {external:TransformStream}
+ * @example
+ * ```js
+ * parse({ src:"lib/jsdoc-parse.js" }).pipe(process.stdout)
+ * ```
+ */
 function jsdocParse (options) {
   options = o.extend(new ParseOptions(), options)
   var src = options.src
@@ -162,10 +164,10 @@ function OutputTransform (options) {
 util.inherits(OutputTransform, Transform)
 
 /*
-Cross-platform. Spawns the command:
-`$ ../node_modules/jsdoc-75lb/jsdoc.js --pedantic -t . -c ../conf.json`
-Uses `publish.js` as a template and the [`plugins/parseHtml`](https://github.com/arodic/jsdoc/commit/0650ac14f2048f7e6c5968630b58dc4b007498aa) plugin.
-*/
+ * Cross-platform. Spawns the command:
+ * `$ ../node_modules/jsdoc-75lb/jsdoc.js --pedantic -t . -c ../conf.json`
+ * Uses `publish.js` as a template and the [`plugins/parseHtml`](https://github.com/arodic/jsdoc/commit/0650ac14f2048f7e6c5968630b58dc4b007498aa) plugin.
+ */
 function getJsdocOutput (src, options, done) {
   var jsdocTemplatePath = path.resolve(__dirname, '..', 'lib')
   var jsdocPath = path.resolve(__dirname, '../node_modules/.bin/jsdoc')
@@ -177,7 +179,7 @@ function getJsdocOutput (src, options, done) {
   if (options.html) {
     args = args.concat([
       '-c',
-      path.resolve(__dirname, 'conf.json')
+      path.resolve(__dirname, 'default-conf.json')
     ])
   } else if (options.conf) {
     args = args.concat([
@@ -208,14 +210,14 @@ function getJsdocOutput (src, options, done) {
   })
 }
 
-jsdocParse.cliOptions = cliOptions.definitions
+
 
 /**
-@param {string} - input json string
-@param {object} - jsdoc-parse options
-@returns {string} - output json string to be streamed out
-@private
-*/
+ * @param {string} - input json string
+ * @param {object} - jsdoc-parse options
+ * @returns {string} - output json string to be streamed out
+ * @private
+ */
 function applyOptions (data, options) {
   data = JSON.parse(data.toString())
   if (options.stats) {
@@ -237,11 +239,11 @@ function applyOptions (data, options) {
 }
 
 /**
-return some stats about the parsed data
-@param {object} - jsdoc-parse data
-@returns {object}
-@private
-*/
+ * return some stats about the parsed data
+ * @param {object} - jsdoc-parse data
+ * @returns {object}
+ * @private
+ */
 function getStats (data) {
   var stats = {
     identifiers: {}
@@ -272,6 +274,6 @@ function sort (array, sortBy) {
 }
 
 /**
-@external TransformStream
-@see http://nodejs.org/api/stream.html#stream_class_stream_transform
-*/
+ * @external TransformStream
+ * @see http://nodejs.org/api/stream.html#stream_class_stream_transform
+ */

lib/jsdoc-parse.js

@@ -0,0 +1,18 @@
+/* class instance property docs not output if `@module` specified  */
+
+/**
+ * @module something
+ */
+
+/**
+ * create something
+ */
+class Something {
+  constructor () {
+    /**
+     * a value
+     * @type {number}
+     */
+    this.whatever = 1
+  }
+}