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. Modified from scrawl.js.

Please report any bugs or feature requests, thanks!

Install

Install with npm:

npm i js-comments --save-dev

bower

bower install js-comments --save

API

parse(src, dest, options)

Usage

var comments = require('js-comments');
var docs = comments('lib/*.js');

See test/actual/comments.json for example output. See index.js for example comments.

src {String}: The source file path
dest {String}: Optional destination file path for generating relative links.
options {Object}:
return {String}

Author

Jon Schlinkert

License

This file was generated by verb-cli on June 15, 2014.