jsdoc-parse
Transforms jsdoc data into something more suitable for use as template input
Last updated 5 years ago by 75lb .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ npm install jsdoc-parse 
SYNC missed versions from official npm registry.

view on npm npm module downloads Gihub repo dependents Gihub package dependents Node.js CI js-standard-style

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-24 Lloyd Brookes <75pound@gmail.com>.

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

Current Tags

  • 6.2.4                                ...           latest (2 months ago)

62 Versions

  • 6.2.4                                ...           2 months ago
  • 6.2.3                                ...           3 months ago
  • 6.2.2                                ...           3 months ago
  • 6.2.1                                ...           9 months ago
  • 6.2.0                                ...           2 years ago
  • 6.1.0                                ...           3 years ago
  • 6.0.1                                ...           3 years ago
  • 6.0.0                                ...           4 years ago
  • 5.0.0                                ...           4 years ago
  • 4.0.1                                ...           5 years ago
  • 4.0.0                                ...           5 years ago
  • 3.0.1                                ...           7 years ago
  • 3.0.0                                ...           8 years ago
  • 2.0.5                                ...           8 years ago
  • 2.0.5-0                                ...           8 years ago
  • 2.0.4                                ...           8 years ago
  • 2.0.3                                ...           8 years ago
  • 2.0.2                                ...           8 years ago
  • 2.0.1                                ...           8 years ago
  • 1.2.7                                ...           9 years ago
  • 2.0.0                                ...           9 years ago
  • 1.2.6                                ...           9 years ago
  • 1.2.5                                ...           9 years ago
  • 1.2.4                                ...           9 years ago
  • 1.2.3                                ...           9 years ago
  • 1.2.2                                ...           9 years ago
  • 1.2.1                                ...           9 years ago
  • 1.2.0                                ...           9 years ago
  • 1.1.3                                ...           9 years ago
  • 1.1.2                                ...           9 years ago
  • 1.1.1                                ...           9 years ago
  • 1.1.0                                ...           9 years ago
  • 1.0.0                                ...           10 years ago
  • 0.3.10 [deprecated]           ...           10 years ago
  • 0.3.9 [deprecated]           ...           10 years ago
  • 0.3.8 [deprecated]           ...           10 years ago
  • 0.3.7 [deprecated]           ...           10 years ago
  • 0.3.6 [deprecated]           ...           10 years ago
  • 0.3.5 [deprecated]           ...           10 years ago
  • 0.3.4 [deprecated]           ...           10 years ago
  • 0.3.3 [deprecated]           ...           10 years ago
  • 0.3.2 [deprecated]           ...           10 years ago
  • 0.2.11                                ...           10 years ago
  • 0.3.1 [deprecated]           ...           10 years ago
  • 0.3.0 [deprecated]           ...           10 years ago
  • 0.2.10                                ...           10 years ago
  • 0.2.9                                ...           10 years ago
  • 0.2.8                                ...           10 years ago
  • 0.2.7                                ...           10 years ago
  • 0.2.6                                ...           10 years ago
  • 0.2.5                                ...           10 years ago
  • 0.2.4                                ...           10 years ago
  • 0.2.3                                ...           10 years ago
  • 0.2.2                                ...           10 years ago
  • 0.2.1                                ...           10 years ago
  • 0.2.0                                ...           10 years ago
  • 0.1.4                                ...           10 years ago
  • 0.1.3                                ...           10 years ago
  • 0.1.2                                ...           10 years ago
  • 0.1.1                                ...           10 years ago
  • 0.1.0                                ...           10 years ago
  • 0.0.0                                ...           10 years ago
Maintainers (1)
Downloads
Total 25
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (6)
Dev Dependencies (1)
Dependents (1)

© 2010 - cnpmjs.org x YWFE | Home | YWFE