JSPM – jsdoc-parse@0.2.1

Package Exports

jsdoc-parse

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (jsdoc-parse) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

#jsdoc-parse Exports a single function (parse) to parse jsdoc data.

Example

var parse = require("jsdoc-parse");

##Install Mac / Linux users may need to run the following with sudo.

###As a library

$ npm install jsdoc-parse --save

###As a command-line tool

$ npm install -g jsdoc-parse

##API Reference ##parse(src, options) ⏏ Documented javascript source files in, doclet data out.

Params

src string | Array.<string> - source file(s) to parse
options object - options
- [stats] boolean - Return stats about the doclets parsed
- [private] boolean - include @private members in the output

Returns: Stream - a readable stream containing the parsed json data
Example
Code like this:

parse("lib/jsdoc-parse.js").pipe(process.stdout);

would output:

[
  {
    "kind": "module",
    "name": "jsdoc-parse",
    "examples": [
      "```js\nvar parse = require(\"jsdoc-parse\");\n```"
    ],
    "longname": "module:jsdoc-parse"
  },
  {
    "description": "Documented javascript source files in, doclet data out.",
    "alias": "module:jsdoc-parse",
    "params": [
      {
        "type": {
          "names": [
            "object"
          ]
        },
        "description": "options",
        "name": "options"
      },
      {
        "type": {
          "names": [
            "string",
            "Array.<string>"
          ]
        },
        "optional": true,
        "description": "source file(s) to parse",
        "name": "options.src"
      },
      {
        "type": {
          "names": [
            "boolean"
          ]
        },
        "optional": true,
        "description": "include @private members in the output",
        "name": "options.private"
      }
    ],
    "returns": [
      {
        "type": {
          "names": [
            "Stream"
          ]
        },
        "description": "a readable stream containing the parsed json data"
      }
    ],
    "examples": [
      "```js\nparse({ src: \"lib/jsdoc-parse.js\" }).pipe(process.stdout);\n```"
    ],
    "name": "module:jsdoc-parse",
    "longname": "module:jsdoc-parse",
    "kind": "function",
    "codeName": "parse"
  },
  {
    "files": [
      "/Users/Lloyd/Documents/75lb/jsdoc-parse/lib/jsdoc-parse.js"
    ],
    "kind": "package",
    "longname": "package:undefined"
  }
]

documented by jsdoc-to-markdown