Miss any of our Open RFC calls?Watch the recordings here! »

jsdoc-parse

5.0.0 • Public • Published

view on npm npm module downloads Gihub repo dependents Gihub package dependents Build 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-20 Lloyd Brookes <75pound@gmail.com>.

Tested by test-runner. Documented by jsdoc-to-markdown.

Install

npm i jsdoc-parse

DownloadsWeekly Downloads

36,923

Version

5.0.0

License

MIT

Unpacked Size

16.3 kB

Total Files

5

Last publish

Collaborators

  • avatar