Package Exports

js-comments

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 (js-comments) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

js-comments

Parse JavaScript code comments and generate API documentation.

Please report any bugs or feature requests, thanks! Also, please note, custom filtering for comments is being implemented, but in the meantime only comments that have @api public will be rendered!

Install with npm

npm i js-comments --save-dev

Install with bower

bower install js-comments --save-dev

API

jsc

patterns {String}: Glob pattern or file paths to use.
dest {String}: Optional destination file path for generating relative links.
options {Object}
returns {String}: String of rendered markdown documentation.

var comments = require('js-comments');
var docs = comments(string);

See example output. See example code comments.

.parseFiles

patterns {String}: Glob pattern or file paths to use.
dest {String}: Optional destination file path for generating relative links.
options {Object}
returns {Array}: Returns an array of comments objects.

Expands the given glob patterns and creates a normalized comments object for each file in the array.

.render

context {Object}
options {Object}
returns {String}: Return the rendered string.

Render a template string with the given context. A custom lodash template may be passed on the options.

Author

Jon Schlinkert

License

This file was generated by verb on February 20, 2015.