@@ -31,7 +31,7 @@ const jsdoc2md = require('jsdoc-to-markdown')
31
31
** Kind** : Exported class
32
32
<a name =" module_jsdoc-to-markdown--JsdocToMarkdown+render " ></a >
33
33
34
- #### jsdoc2md.render([ options] ) -> <code >Promise</code >
34
+ #### jsdoc2md.render([ options] ) → <code >Promise</code >
35
35
Returns markdown documentation from jsdoc-annoted source code.
36
36
37
37
** 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:
64
64
```
65
65
<a name =" module_jsdoc-to-markdown--JsdocToMarkdown+getTemplateData " ></a >
66
66
67
- #### jsdoc2md.getTemplateData([ options] ) -> <code >Promise</code >
67
+ #### jsdoc2md.getTemplateData([ options] ) → <code >Promise</code >
68
68
Returns the template data (jsdoc-parse output) which is fed into the output template (dmd).
69
69
70
70
** 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
77
77
78
78
<a name =" module_jsdoc-to-markdown--JsdocToMarkdown+getJsdocData " ></a >
79
79
80
- #### jsdoc2md.getJsdocData([ options] ) -> <code >Promise</code >
80
+ #### jsdoc2md.getJsdocData([ options] ) → <code >Promise</code >
81
81
Returns raw data direct from the underlying [ jsdoc3] ( https://github.com/jsdoc3/jsdoc ) .
82
82
83
83
** 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
94
94
95
95
<a name =" module_jsdoc-to-markdown--JsdocToMarkdown+clear " ></a >
96
96
97
- #### jsdoc2md.clear() -> <code >Promise</code >
97
+ #### jsdoc2md.clear() → <code >Promise</code >
98
98
By 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.
99
99
100
100
** Kind** : instance method of [ <code >JsdocToMarkdown</code >] ( #exp_module_jsdoc-to-markdown--JsdocToMarkdown )
101
101
** Category** : async
102
102
<a name =" module_jsdoc-to-markdown--JsdocToMarkdown+getNamepaths " ></a >
103
103
104
- #### jsdoc2md.getNamepaths(options) -> <code >object</code >
104
+ #### jsdoc2md.getNamepaths(options) → <code >object</code >
105
105
Returns all [ jsdoc namepaths] ( http://usejsdoc.org/about-namepaths.html ) found in the supplied source code.
106
106
107
107
** 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
113
113
114
114
<a name =" module_jsdoc-to-markdown--JsdocToMarkdown+renderSync " ></a >
115
115
116
- #### jsdoc2md.renderSync([ options] ) -> <code >string</code >
116
+ #### jsdoc2md.renderSync([ options] ) → <code >string</code >
117
117
Sync version of [ render] ( #module_jsdoc-to-markdown--JsdocToMarkdown+render ) .
118
118
119
119
** Kind** : instance method of [ <code >JsdocToMarkdown</code >] ( #exp_module_jsdoc-to-markdown--JsdocToMarkdown )
@@ -130,7 +130,7 @@ const docs = jsdoc2md.renderSync({ files: 'lib/*.js' })
130
130
```
131
131
<a name =" module_jsdoc-to-markdown--JsdocToMarkdown+getTemplateDataSync " ></a >
132
132
133
- #### jsdoc2md.getTemplateDataSync([ options] ) -> <code >Array.< ; object> ; </code >
133
+ #### jsdoc2md.getTemplateDataSync([ options] ) → <code >Array.< ; object> ; </code >
134
134
Sync version of [ getTemplateData] ( #module_jsdoc-to-markdown--JsdocToMarkdown+getTemplateData ) .
135
135
136
136
** 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
142
142
143
143
<a name =" module_jsdoc-to-markdown--JsdocToMarkdown+getJsdocDataSync " ></a >
144
144
145
- #### jsdoc2md.getJsdocDataSync([ options] ) -> <code >Array.< ; object> ; </code >
145
+ #### jsdoc2md.getJsdocDataSync([ options] ) → <code >Array.< ; object> ; </code >
146
146
Sync version of [ getJsdocData] ( #module_jsdoc-to-markdown--JsdocToMarkdown+getJsdocData ) .
147
147
148
148
** Kind** : instance method of [ <code >JsdocToMarkdown</code >] ( #exp_module_jsdoc-to-markdown--JsdocToMarkdown )
0 commit comments