Transforms jsdoc data into something more suitable for use as template input
Transforms jsdoc data into something more suitable for use as template input. Also adds a few tags to the default set:
@category <string>: Useful for grouping identifiers by category.
@done: Used to mark
@todoitems 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
@chainable: Set to mark a method as chainable (has a return value of
This module is built into jsdoc-to-markdown, you can see the output using this command:
$ jsdoc2md --json <files>