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 Jsdoc-annotated javascript source files in, dmd input data out.
##Compatible Platforms Tested on Mac OSX, Linux, Windows 8.1 and Windows XP.
##As a command-line tool Useful for quick access to the data..
###Install
$ npm install -g jsdoc-parse###Usage
$ jsdoc-parse <src_files>
$ cat <src_files> | jsdoc-parse Usage form 2 edge case warning: jsdoc-parse will intepret whatever is piped in as a single file, so take care not to pipe in input containing multipe @modules as this is illegal in jsdoc (see here):
The @module tag marks the current file as being its own module. All symbols in the file are assumed to be members of the module unless documented otherwise.
###Example
$ echo "/** a wonderful global */ var majestic = true;" | jsdoc-parse
[
{
"description": "a wonderful global",
"name": "majestic",
"longname": "majestic",
"kind": "member",
"scope": "global"
}
]##As a library For use within node.js.
###Install
$ npm install jsdoc-parse --save###API Reference
Exports a single function (parse) to parse jsdoc data.
Example
var parse = require("jsdoc-parse");
###parse(src, options) ⇒ Stream ⏏
Documented javascript source in, documentation JSON out.
| Param | Type | Description |
|---|---|---|
| src | string | Array.<string> |
source file(s) to parse |
| options | object |
options |
| [options.stats] | boolean |
Return stats about the doclets parsed |
| [options.private] | boolean |
include @private members in the output |
Returns: Stream - a readable stream containing the parsed json data
Todo
- split into two separate methods
Example
Code like this:
parse("lib/jsdoc-parse.js").pipe(process.stdout);would output something like:
[
{
"description": "Exports a single function (`parse`) to parse jsdoc data.",
"kind": "module",
"name": "jsdoc-parse",
"examples": [
"```js\nvar parse = require(\"jsdoc-parse\");\n```"
],
"longname": "module:jsdoc-parse"
},
etc,
etc
]documented by jsdoc-to-markdown