js-comments

Parse JavaScript code comments and generate API documentation.

js-comments

Parse JavaScript code comments and generate API documentation.

Install with npm

npm i js-comments --save

Install with bower

bower install js-comments --save-dev

(Table of contents generated by verb)

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

Heads up!, only comments with @api public will be rendered!

.parse

Parse comments from the given str.

Params

  • str {String}: The string to parse.
  • returns {Object}: Object of comments.

Example

comments.parse(str, options);

.render

Process the given Lo-dash template string, passing a comments object as context.

Params

  • template {String}: The lo-dash template to use.
  • comments {Object}: Object of comments.
  • returns {String}

Example

comments.render(obj, options);

.renderFile

Write markdown API documentation to the given dest from the code comments in the given JavaScript src file.

Params

  • src {String}: Source file path.
  • dest {String}: Destination file path.
  • options {Object}
  • returns {String}: API documentation

Install dev dependencies:

npm i -d && npm test

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Jon Schlinkert

Copyright (c) 2014-2015 Jon Schlinkert Originally modified from scrawl.js. Copyright (c) 2014 Caolan McMahon, contributors. Released under the MIT license.


This file was generated by verb-cli on April 25, 2015.