parses jsdoc documentation from javascript or html files, outputs JSON
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
jsdoc2md upgrade deps Jan 9, 2018
lib remove sortBy option Aug 6, 2016
test
.gitignore
.travis.yml upgrade deps Jan 9, 2018
LICENSE.md upgrade deps Jan 9, 2018
README.md upgrade deps Jan 9, 2018
package.json 3.0.1 Jan 9, 2018

README.md

view on npm npm module downloads Build Status Dependency Status js-standard-style Join the chat at https://gitter.im/jsdoc2md/jsdoc2md

jsdoc-parse

Transforms jsdoc data into something more suitable for use as template input. Also adds a few tags to the default set:

  • Support for new tags in the input javascript
    • @category <string>: Useful for grouping identifiers by category.
    • @done: Used to mark @todo items as complete.
    • @typicalname: If set on a class, namespace or module, child members will documented using this typical name as the parent name. Real-world typical name examples are $ (the typical name for jQuery instances), _ (underscore) etc.
    • @chainable: Set to mark a method as chainable (has a return value of this).

Command-line usage

This module is built into jsdoc-to-markdown, you can see the output using this command:

$ jsdoc2md --json <files>

© 2014-18 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.