@@ -31,7 +31,7 @@ const jsdoc2md = require('jsdoc-to-markdown')
3131** Kind** : Exported class
3232<a name =" module_jsdoc-to-markdown--JsdocToMarkdown+render " ></a >
3333
34- #### jsdoc2md.render([ options] ) -> <code >Promise</code >
34+ #### jsdoc2md.render([ options] ) → <code >Promise</code >
3535Returns markdown documentation from jsdoc-annoted source code.
3636
3737** Kind** : instance method of [ <code >JsdocToMarkdown</code >] ( #exp_module_jsdoc-to-markdown--JsdocToMarkdown )
@@ -64,7 +64,7 @@ Pass in filepaths (`**` glob matching supported) of javascript source files:
6464```
6565<a name =" module_jsdoc-to-markdown--JsdocToMarkdown+getTemplateData " ></a >
6666
67- #### jsdoc2md.getTemplateData([ options] ) -> <code >Promise</code >
67+ #### jsdoc2md.getTemplateData([ options] ) → <code >Promise</code >
6868Returns the template data (jsdoc-parse output) which is fed into the output template (dmd).
6969
7070** Kind** : instance method of [ <code >JsdocToMarkdown</code >] ( #exp_module_jsdoc-to-markdown--JsdocToMarkdown )
@@ -77,7 +77,7 @@ Returns the template data (jsdoc-parse output) which is fed into the output temp
7777
7878<a name =" module_jsdoc-to-markdown--JsdocToMarkdown+getJsdocData " ></a >
7979
80- #### jsdoc2md.getJsdocData([ options] ) -> <code >Promise</code >
80+ #### jsdoc2md.getJsdocData([ options] ) → <code >Promise</code >
8181Returns raw data direct from the underlying [ jsdoc3] ( https://github.com/jsdoc3/jsdoc ) .
8282
8383** Kind** : instance method of [ <code >JsdocToMarkdown</code >] ( #exp_module_jsdoc-to-markdown--JsdocToMarkdown )
@@ -94,14 +94,14 @@ Returns raw data direct from the underlying [jsdoc3](https://github.com/jsdoc3/j
9494
9595<a name =" module_jsdoc-to-markdown--JsdocToMarkdown+clear " ></a >
9696
97- #### jsdoc2md.clear() -> <code >Promise</code >
97+ #### jsdoc2md.clear() → <code >Promise</code >
9898By default, the output of each invocation of the main generation methods (` render ` , ` getTemplateData ` etc) is stored in the cache (your system's [ temporary directory] ( https://nodejs.org/dist/latest-v6.x/docs/api/os.html#os_os_tmpdir ) ). Future jsdoc2md invocations with the same input options and source code will return the output immediately from cache, making the tool much faster/cheaper. If the input options or source code changes, fresh output will be generated. This method clears the cache, which you should never need to do unless the cache is failing for some reason. On Mac OSX, the system tmpdir clears itself every few days meaning your jsdoc2md cache will also be routinely cleared.
9999
100100** Kind** : instance method of [ <code >JsdocToMarkdown</code >] ( #exp_module_jsdoc-to-markdown--JsdocToMarkdown )
101101** Category** : async
102102<a name =" module_jsdoc-to-markdown--JsdocToMarkdown+getNamepaths " ></a >
103103
104- #### jsdoc2md.getNamepaths(options) -> <code >object</code >
104+ #### jsdoc2md.getNamepaths(options) → <code >object</code >
105105Returns all [ jsdoc namepaths] ( http://usejsdoc.org/about-namepaths.html ) found in the supplied source code.
106106
107107** Kind** : instance method of [ <code >JsdocToMarkdown</code >] ( #exp_module_jsdoc-to-markdown--JsdocToMarkdown )
@@ -113,7 +113,7 @@ Returns all [jsdoc namepaths](http://usejsdoc.org/about-namepaths.html) found in
113113
114114<a name =" module_jsdoc-to-markdown--JsdocToMarkdown+renderSync " ></a >
115115
116- #### jsdoc2md.renderSync([ options] ) -> <code >string</code >
116+ #### jsdoc2md.renderSync([ options] ) → <code >string</code >
117117Sync version of [ render] ( #module_jsdoc-to-markdown--JsdocToMarkdown+render ) .
118118
119119** Kind** : instance method of [ <code >JsdocToMarkdown</code >] ( #exp_module_jsdoc-to-markdown--JsdocToMarkdown )
@@ -130,7 +130,7 @@ const docs = jsdoc2md.renderSync({ files: 'lib/*.js' })
130130```
131131<a name =" module_jsdoc-to-markdown--JsdocToMarkdown+getTemplateDataSync " ></a >
132132
133- #### jsdoc2md.getTemplateDataSync([ options] ) -> <code >Array.< ; object> ; </code >
133+ #### jsdoc2md.getTemplateDataSync([ options] ) → <code >Array.< ; object> ; </code >
134134Sync version of [ getTemplateData] ( #module_jsdoc-to-markdown--JsdocToMarkdown+getTemplateData ) .
135135
136136** Kind** : instance method of [ <code >JsdocToMarkdown</code >] ( #exp_module_jsdoc-to-markdown--JsdocToMarkdown )
@@ -142,7 +142,7 @@ Sync version of [getTemplateData](#module_jsdoc-to-markdown--JsdocToMarkdown+get
142142
143143<a name =" module_jsdoc-to-markdown--JsdocToMarkdown+getJsdocDataSync " ></a >
144144
145- #### jsdoc2md.getJsdocDataSync([ options] ) -> <code >Array.< ; object> ; </code >
145+ #### jsdoc2md.getJsdocDataSync([ options] ) → <code >Array.< ; object> ; </code >
146146Sync version of [ getJsdocData] ( #module_jsdoc-to-markdown--JsdocToMarkdown+getJsdocData ) .
147147
148148** Kind** : instance method of [ <code >JsdocToMarkdown</code >] ( #exp_module_jsdoc-to-markdown--JsdocToMarkdown )
0 commit comments