Skip to content

Commit 4b4305d

Browse files
75lb75lb
committed
upgrade jsdoc to 3.5.3.. remove html-parsing option
1 parent 82c85cf commit 4b4305d

File tree

14 files changed

+1751
-210
lines changed

14 files changed

+1751
-210
lines changed

‎.travis.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ node_js:
44
- 5
55
- 6
66
- 7
7+
- 8

‎README.md

Lines changed: 29 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ A programmatic interface for [jsdoc3](https://github.com/jsdoc3/jsdoc) with a fe
1313
- Sync and async (Promise) interfaces on the two main jsdoc operations ('explain' and 'render documentation').
1414
- Input (source code) can supplied as a string or set of file names/globs.
1515
- Optional caching, dramatically speeding up future invocations with the same input.
16-
- Supports html input
1716

1817
## Synopsis
1918

@@ -47,13 +46,13 @@ A programmatic interface for [jsdoc3](https://github.com/jsdoc3/jsdoc) with a fe
4746

4847
* [jsdoc-api](#module_jsdoc-api)
4948
* _static_
50-
* [.cache](#module_jsdoc-api.cache) : <code>[cache-point](https://github.com/75lb/cache-point)</code>
49+
* [.cache](#module_jsdoc-api.cache) : [<code>cache-point</code>](https://github.com/75lb/cache-point)
5150
* [.explainSync([options])](#module_jsdoc-api.explainSync) ⇒ <code>Array.&lt;object&gt;</code>
5251
* [.explain([options])](#module_jsdoc-api.explain) ⇒ <code>Promise</code>
5352
* [.renderSync([options])](#module_jsdoc-api.renderSync)
5453
* _inner_
5554
* [~JsdocOptions](#module_jsdoc-api..JsdocOptions)
56-
* [.files](#module_jsdoc-api..JsdocOptions.JsdocOptions+files) : <code>string</code> &#124; <code>Array.&lt;string&gt;</code>
55+
* [.files](#module_jsdoc-api..JsdocOptions.JsdocOptions+files) : <code>string</code> \| <code>Array.&lt;string&gt;</code>
5756
* [.source](#module_jsdoc-api..JsdocOptions.JsdocOptions+source) : <code>string</code>
5857
* [.cache](#module_jsdoc-api..JsdocOptions.JsdocOptions+cache) : <code>boolean</code>
5958
* [.access](#module_jsdoc-api..JsdocOptions.JsdocOptions+access) : <code>string</code>
@@ -68,63 +67,62 @@ A programmatic interface for [jsdoc3](https://github.com/jsdoc3/jsdoc) with a fe
6867
* [.readme](#module_jsdoc-api..JsdocOptions.JsdocOptions+readme) : <code>string</code>
6968
* [.template](#module_jsdoc-api..JsdocOptions.JsdocOptions+template) : <code>string</code>
7069
* [.tutorials](#module_jsdoc-api..JsdocOptions.JsdocOptions+tutorials) : <code>string</code>
71-
* [.html](#module_jsdoc-api..JsdocOptions.JsdocOptions+html) : <code>boolean</code>
7270

7371
<a name="module_jsdoc-api.cache"></a>
7472

75-
### jsdoc.cache : <code>[cache-point](https://github.com/75lb/cache-point)</code>
73+
### jsdoc.cache : [<code>cache-point</code>](https://github.com/75lb/cache-point)
7674
The [cache-point](https://github.com/75lb/cache-point) instance used when `cache: true` is specified on `.explain()` or `.explainSync()`.
7775

78-
**Kind**: static property of <code>[jsdoc-api](#module_jsdoc-api)</code>
76+
**Kind**: static property of [<code>jsdoc-api</code>](#module_jsdoc-api)
7977
<a name="module_jsdoc-api.explainSync"></a>
8078

8179
### jsdoc.explainSync([options]) ⇒ <code>Array.&lt;object&gt;</code>
8280
Returns jsdoc explain output.
8381

84-
**Kind**: static method of <code>[jsdoc-api](#module_jsdoc-api)</code>
82+
**Kind**: static method of [<code>jsdoc-api</code>](#module_jsdoc-api)
8583
**Prerequisite**: Requires node v0.12 or above
8684

8785
| Param | Type |
8886
| --- | --- |
89-
| [options] | <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code> |
87+
| [options] | [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions) |
9088

9189
<a name="module_jsdoc-api.explain"></a>
9290

9391
### jsdoc.explain([options]) ⇒ <code>Promise</code>
9492
Returns a promise for the jsdoc explain output.
9593

96-
**Kind**: static method of <code>[jsdoc-api](#module_jsdoc-api)</code>
94+
**Kind**: static method of [<code>jsdoc-api</code>](#module_jsdoc-api)
9795
**Fulfil**: <code>object[]</code> - jsdoc explain output
9896

9997
| Param | Type |
10098
| --- | --- |
101-
| [options] | <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code> |
99+
| [options] | [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions) |
102100

103101
<a name="module_jsdoc-api.renderSync"></a>
104102

105103
### jsdoc.renderSync([options])
106104
Render jsdoc documentation.
107105

108-
**Kind**: static method of <code>[jsdoc-api](#module_jsdoc-api)</code>
106+
**Kind**: static method of [<code>jsdoc-api</code>](#module_jsdoc-api)
109107
**Prerequisite**: Requires node v0.12 or above
110108

111109
| Param | Type |
112110
| --- | --- |
113-
| [options] | <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code> |
111+
| [options] | [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions) |
114112

115113
**Example**
116114
```js
117115
jsdoc.renderSync({ files: 'lib/*', destination: 'api-docs' })
118116
```
119117
<a name="module_jsdoc-api..JsdocOptions"></a>
120118

121-
### jsdoc~JsdocOptions
119+
### jsdoc-api~JsdocOptions
122120
The jsdoc options, common for all operations.
123121

124-
**Kind**: inner class of <code>[jsdoc-api](#module_jsdoc-api)</code>
122+
**Kind**: inner class of [<code>jsdoc-api</code>](#module_jsdoc-api)
125123

126124
* [~JsdocOptions](#module_jsdoc-api..JsdocOptions)
127-
* [.files](#module_jsdoc-api..JsdocOptions.JsdocOptions+files) : <code>string</code> &#124; <code>Array.&lt;string&gt;</code>
125+
* [.files](#module_jsdoc-api..JsdocOptions.JsdocOptions+files) : <code>string</code> \| <code>Array.&lt;string&gt;</code>
128126
* [.source](#module_jsdoc-api..JsdocOptions.JsdocOptions+source) : <code>string</code>
129127
* [.cache](#module_jsdoc-api..JsdocOptions.JsdocOptions+cache) : <code>boolean</code>
130128
* [.access](#module_jsdoc-api..JsdocOptions.JsdocOptions+access) : <code>string</code>
@@ -139,104 +137,97 @@ The jsdoc options, common for all operations.
139137
* [.readme](#module_jsdoc-api..JsdocOptions.JsdocOptions+readme) : <code>string</code>
140138
* [.template](#module_jsdoc-api..JsdocOptions.JsdocOptions+template) : <code>string</code>
141139
* [.tutorials](#module_jsdoc-api..JsdocOptions.JsdocOptions+tutorials) : <code>string</code>
142-
* [.html](#module_jsdoc-api..JsdocOptions.JsdocOptions+html) : <code>boolean</code>
143140

144141
<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+files"></a>
145142

146-
#### options.files : <code>string</code> &#124; <code>Array.&lt;string&gt;</code>
143+
#### options.files : <code>string</code> \| <code>Array.&lt;string&gt;</code>
147144
One or more filenames to process. Either this or `source` must be supplied.
148145

149-
**Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>
146+
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
150147
<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+source"></a>
151148

152149
#### options.source : <code>string</code>
153150
A string containing source code to process. Either this or `source` must be supplied.
154151

155-
**Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>
152+
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
156153
<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+cache"></a>
157154

158155
#### options.cache : <code>boolean</code>
159156
Set to `true` to cache the output - future invocations with the same input will return immediately.
160157

161-
**Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>
158+
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
162159
<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+access"></a>
163160

164161
#### options.access : <code>string</code>
165162
Only display symbols with the given access: "public", "protected", "private" or "undefined", or "all" for all access levels. Default: all except "private".
166163

167-
**Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>
164+
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
168165
<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+configure"></a>
169166

170167
#### options.configure : <code>string</code>
171168
The path to the configuration file. Default: path/to/jsdoc/conf.json.
172169

173-
**Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>
170+
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
174171
<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+destination"></a>
175172

176173
#### options.destination : <code>string</code>
177174
The path to the output folder. Use "console" to dump data to the console. Default: ./out/.
178175

179-
**Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>
176+
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
180177
<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+encoding"></a>
181178

182179
#### options.encoding : <code>string</code>
183180
Assume this encoding when reading all source files. Default: utf8.
184181

185-
**Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>
182+
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
186183
<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+private"></a>
187184

188185
#### options.private : <code>boolean</code>
189186
Display symbols marked with the @private tag. Equivalent to "--access all". Default: false.
190187

191-
**Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>
188+
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
192189
<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+package"></a>
193190

194191
#### options.package : <code>string</code>
195192
The path to the project's package file. Default: path/to/sourcefiles/package.json
196193

197-
**Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>
194+
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
198195
<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+pedantic"></a>
199196

200197
#### options.pedantic : <code>boolean</code>
201198
Treat errors as fatal errors, and treat warnings as errors. Default: false.
202199

203-
**Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>
200+
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
204201
<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+query"></a>
205202

206203
#### options.query : <code>string</code>
207204
A query string to parse and store in jsdoc.env.opts.query. Example: foo=bar&baz=true.
208205

209-
**Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>
206+
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
210207
<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+recurse"></a>
211208

212209
#### options.recurse : <code>boolean</code>
213210
Recurse into subdirectories when scanning for source files and tutorials.
214211

215-
**Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>
212+
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
216213
<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+readme"></a>
217214

218215
#### options.readme : <code>string</code>
219216
The path to the project's README file. Default: path/to/sourcefiles/README.md.
220217

221-
**Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>
218+
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
222219
<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+template"></a>
223220

224221
#### options.template : <code>string</code>
225222
The path to the template to use. Default: path/to/jsdoc/templates/default.
226223

227-
**Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>
224+
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
228225
<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+tutorials"></a>
229226

230227
#### options.tutorials : <code>string</code>
231228
Directory in which JSDoc should search for tutorials.
232229

233-
**Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>
234-
<a name="module_jsdoc-api..JsdocOptions.JsdocOptions+html"></a>
235-
236-
#### options.html : <code>boolean</code>
237-
Enable experimental parsing of `.html` files.
238-
239-
**Kind**: instance property of <code>[JsdocOptions](#module_jsdoc-api..JsdocOptions)</code>
230+
**Kind**: instance property of [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions)
240231

241232
* * *
242233

‎jsdoc2md/README.hbs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ A programmatic interface for [jsdoc3](https://github.com/jsdoc3/jsdoc) with a fe
1313
- Sync and async (Promise) interfaces on the two main jsdoc operations ('explain' and 'render documentation').
1414
- Input (source code) can supplied as a string or set of file names/globs.
1515
- Optional caching, dramatically speeding up future invocations with the same input.
16-
- Supports html input
1716

1817
## Synopsis
1918

‎lib/html-conf.json

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎lib/jsdoc-api.js

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -161,18 +161,6 @@ class JsdocOptions {
161161
* @type {string}
162162
*/
163163
this.tutorials = options.tutorials
164-
165-
/**
166-
* Enable experimental parsing of `.html` files.
167-
* @type {boolean}
168-
*/
169-
this.html = options.html
170-
171-
if (this.html) {
172-
const path = require('path')
173-
this.configure = path.resolve(__dirname, 'html-conf.json')
174-
delete this.html
175-
}
176164
}
177165
}
178166

‎lib/jsdoc-command.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class JsdocCommand {
3131
const walkBack = require('walk-back')
3232
this.jsdocPath = walkBack(
3333
path.join(__dirname, '..'),
34-
path.join('node_modules', 'jsdoc-75lb', 'jsdoc.js')
34+
path.join('node_modules', 'jsdoc', 'jsdoc.js')
3535
)
3636
}
3737

0 commit comments

Comments
 (0)