-
Notifications
You must be signed in to change notification settings - Fork 151
How jsdoc2md works
Lloyd Brookes edited this page Oct 9, 2016
·
4 revisions
This is the main use case (render documentation) sequence:
- User runs
jsdoc2md example.js
. - jsdoc-api is used to obtain the raw jsdoc data for the input source code provided.
- this data is transformed into something suitable for passing into a template by jsdoc-parse (which also adds support for the jsdoc2md-specific tags like
@typicalname
,@done
,@category
etc). - the resulting template data is passed into dmd (the default output template). This output is returned to the user.
- Home
- How jsdoc2md works
- Additional jsdoc tags supported
- Cherry picking which documentation appears in output
- Showcase ...
- Create ...
- How To ...
- How to use with npm run
- How to use with gulp
- How to create one output file per class
- How to document a AMD module
- How to document a CommonJS module (exports)
- How to document a CommonJS module (module.exports)
- How to document an ES2015 module (multiple named exports)
- How to document an ES2015 module (single default export)
- How to document Promises (using custom tags)
- How to document a ToDo list
- How to document ES2017 features
- How to document TypeScript
- The @typicalname tag
- Linking to external resources
- Param list format options
- Listing namepaths
- Troubleshooting