Newlyweds Proposing Marriage

    js-comments

    0.5.4 • Public • Published

    js-comments NPM version Build Status

    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

    (Table of contents generated by [verb])

    Usage

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

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

    API

    .parse

    Parse comments from the given str.

    Params

    • str {String}: The string to parse.
    • options {Object}: Options to pass to [parse-comments]
    • returns {Array}: Array of comment objects.

    Example

    var fs = require('fs');
    var str = fs.readFileSync('foo.js', 'utf8');
    comments.parse(str, options);

    .render

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

    Params

    • comments {Array}: Array of comment objects.
    • template {String}: The lo-dash template to use.
    • 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

    Other awesome projects

    • code-context: Parse a string of javascript to determine the context for functions, variables and comments based… more
    • esprima-extract-comments: Extract code comments from string or from a glob of files using esprima.
    • extract-comments: Extract code comments from string or from a glob of files.
    • parse-code-context: Parse code context in a single line of javascript, for functions, variable declarations, methods, prototype… more

    Running tests

    Install dev dependencies:

    $ npm i -d && npm test

    Contributing

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

    Author

    Jon Schlinkert

    License

    Copyright © 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 May 29, 2015.

    Install

    npm i js-comments

    DownloadsWeekly Downloads

    285

    Version

    0.5.4

    License

    MIT

    Last publish

    Collaborators

    • jonschlinkert
    • doowb