Package Exports

jsdoc-parse
jsdoc-parse/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (jsdoc-parse) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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>

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