Skip to content
Lloyd Brookes edited this page Oct 9, 2016 · 4 revisions

This is the main use case (render documentation) sequence:

  1. User runs jsdoc2md example.js.
  2. jsdoc-api is used to obtain the raw jsdoc data for the input source code provided.
  3. 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).
  4. the resulting template data is passed into dmd (the default output template). This output is returned to the user.
Clone this wiki locally