History

juanelas c29b520108 JS Standard. Some fixes with the test. Better structure		2020-04-06 13:17:22 +02:00
..
lib	JS Standard. Some fixes with the test. Better structure	2020-04-06 13:17:22 +02:00
LICENSE.md	JS Standard. Some fixes with the test. Better structure	2020-04-06 13:17:22 +02:00
README.md	JS Standard. Some fixes with the test. Better structure	2020-04-06 13:17:22 +02:00
index.js	JS Standard. Some fixes with the test. Better structure	2020-04-06 13:17:22 +02:00
package.json	JS Standard. Some fixes with the test. Better structure	2020-04-06 13:17:22 +02:00

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>