Skip to content
Lloyd Brookes edited this page Oct 9, 2016 · 1 revision

1. If you're not sure what the namepath for a given identifier is, run jsdoc2md --namepaths against your code for a full list:

$ jsdoc2md src/lib/jsdoc-to-markdown.js --namepaths
{
  "module": [
    "module:jsdoc-to-markdown"
  ],
  "class": [
    "module:jsdoc-to-markdown"
  ],
  "constructor": [],
  "mixin": [],
  "member": [],
  "namespace": [],
  "constant": [],
  "function": [
    "module:jsdoc-to-markdown#render",
    "module:jsdoc-to-markdown#getTemplateData",
    "module:jsdoc-to-markdown#getJsdocData",
    "module:jsdoc-to-markdown#clear",
    "module:jsdoc-to-markdown#getNamepaths",
    "module:jsdoc-to-markdown#renderSync",
    "module:jsdoc-to-markdown#getTemplateDataSync",
    "module:jsdoc-to-markdown#getJsdocDataSync"
  ],
  "event": [],
  "typedef": [],
  "external": []
}
Clone this wiki locally