1 | # Change Log
|
2 |
|
3 | All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
4 |
|
5 | <a name="12.0.0"></a>
|
6 | # [12.0.0](https://github.com/documentationjs/documentation/compare/v11.0.1...v12.0.0) (2019-07-10)
|
7 |
|
8 |
|
9 | * Formatted with Prettier ([8f36e75](https://github.com/documentationjs/documentation/commit/8f36e75))
|
10 |
|
11 |
|
12 | ### BREAKING CHANGES
|
13 |
|
14 | * The next release will require Node 8
|
15 |
|
16 |
|
17 |
|
18 | <a name="11.0.1"></a>
|
19 | ## [11.0.1](https://github.com/documentationjs/documentation/compare/v11.0.0...v11.0.1) (2019-06-12)
|
20 |
|
21 |
|
22 | ### Bug Fixes
|
23 |
|
24 | * toc with children getting displayed as "note" ([#1253](https://github.com/documentationjs/documentation/issues/1253)) ([14298bb](https://github.com/documentationjs/documentation/commit/14298bb))
|
25 |
|
26 |
|
27 |
|
28 | <a name="11.0.0"></a>
|
29 | # [11.0.0](https://github.com/documentationjs/documentation/compare/v10.1.0...v11.0.0) (2019-05-08)
|
30 |
|
31 |
|
32 | ### Bug Fixes
|
33 |
|
34 | * Fix parsing of optional parameters with annotations ([ca17de5](https://github.com/documentationjs/documentation/commit/ca17de5))
|
35 |
|
36 |
|
37 | ### Features
|
38 |
|
39 | * Enable all parser plugins ([fa1b0b5](https://github.com/documentationjs/documentation/commit/fa1b0b5))
|
40 | * Support exportNamespaceFrom in parser ([8fa141d](https://github.com/documentationjs/documentation/commit/8fa141d))
|
41 |
|
42 |
|
43 | ### BREAKING CHANGES
|
44 |
|
45 | * this removes support for legacy decorators, because
|
46 | in one place we had legacy and in another we didn't.
|
47 |
|
48 |
|
49 |
|
50 | <a name="10.1.0"></a>
|
51 | # [10.1.0](https://github.com/documentationjs/documentation/compare/v10.0.0...v10.1.0) (2019-04-25)
|
52 |
|
53 |
|
54 | ### Features
|
55 |
|
56 | * TypeScript support & inference ([3773e02](https://github.com/documentationjs/documentation/commit/3773e02))
|
57 |
|
58 |
|
59 |
|
60 | <a name="10.0.0"></a>
|
61 | # [10.0.0](https://github.com/documentationjs/documentation/compare/v10.0.0-alpha.0...v10.0.0) (2019-04-18)
|
62 |
|
63 |
|
64 | ### Features
|
65 |
|
66 | * Add flow inference for generators ([7947e97](https://github.com/documentationjs/documentation/commit/7947e97))
|
67 | * Support async functions ([d31c3b7](https://github.com/documentationjs/documentation/commit/d31c3b7))
|
68 | * Support classPrivateProperties in parser ([64ef671](https://github.com/documentationjs/documentation/commit/64ef671)), closes [#1216](https://github.com/documentationjs/documentation/issues/1216)
|
69 | * Support generator functions ([8e3cd47](https://github.com/documentationjs/documentation/commit/8e3cd47))
|
70 |
|
71 |
|
72 |
|
73 | <a name="10.0.0-alpha.0"></a>
|
74 | # [10.0.0-alpha.0](https://github.com/documentationjs/documentation/compare/v9.3.1...v10.0.0-alpha.0) (2019-03-12)
|
75 |
|
76 |
|
77 | ### Features
|
78 |
|
79 | * Support custom babel config ([#1205](https://github.com/documentationjs/documentation/issues/1205)) ([746d0a9](https://github.com/documentationjs/documentation/commit/746d0a9))
|
80 |
|
81 |
|
82 | ### BREAKING CHANGES
|
83 |
|
84 | * this may change babel configuration loading, and is a
|
85 | major change to the documentation.js approach to Babel.
|
86 |
|
87 |
|
88 |
|
89 | <a name="9.3.1"></a>
|
90 | ## [9.3.1](https://github.com/documentationjs/documentation/compare/v9.3.0...v9.3.1) (2019-03-12)
|
91 |
|
92 |
|
93 |
|
94 | <a name="9.3.0"></a>
|
95 | # [9.3.0](https://github.com/documentationjs/documentation/compare/v9.2.1...v9.3.0) (2019-02-27)
|
96 |
|
97 |
|
98 | ### Features
|
99 |
|
100 | * Add inner section ([#1212](https://github.com/documentationjs/documentation/issues/1212)) ([64c9ca6](https://github.com/documentationjs/documentation/commit/64c9ca6))
|
101 |
|
102 |
|
103 |
|
104 | <a name="9.2.1"></a>
|
105 | ## [9.2.1](https://github.com/documentationjs/documentation/compare/v9.2.0...v9.2.1) (2019-02-26)
|
106 |
|
107 |
|
108 |
|
109 | <a name="9.2.0"></a>
|
110 | # [9.2.0](https://github.com/documentationjs/documentation/compare/v9.1.1...v9.2.0) (2019-02-22)
|
111 |
|
112 |
|
113 | ### Bug Fixes
|
114 |
|
115 | * **default theme:** only render either note or section (fixes [#1113](https://github.com/documentationjs/documentation/issues/1113)) ([#1206](https://github.com/documentationjs/documentation/issues/1206)) ([fb0a27f](https://github.com/documentationjs/documentation/commit/fb0a27f))
|
116 |
|
117 |
|
118 | ### Features
|
119 |
|
120 | * Add favicon option ([#1207](https://github.com/documentationjs/documentation/issues/1207)) ([5b045f2](https://github.com/documentationjs/documentation/commit/5b045f2))
|
121 |
|
122 |
|
123 |
|
124 | <a name="9.1.1"></a>
|
125 | ## [9.1.1](https://github.com/documentationjs/documentation/compare/v9.1.0...v9.1.1) (2018-12-21)
|
126 |
|
127 |
|
128 | ### Bug Fixes
|
129 |
|
130 | * inferred properties duplicating explicitly specified ones ([2d0bd0e](https://github.com/documentationjs/documentation/commit/2d0bd0e))
|
131 |
|
132 |
|
133 |
|
134 | <a name="9.1.0"></a>
|
135 | # [9.1.0](https://github.com/documentationjs/documentation/compare/v9.0.0...v9.1.0) (2018-12-17)
|
136 |
|
137 |
|
138 | ### Features
|
139 |
|
140 | * support spead types ([ca5a681](https://github.com/documentationjs/documentation/commit/ca5a681))
|
141 |
|
142 |
|
143 |
|
144 | <a name="9.0.0"></a>
|
145 | # [9.0.0](https://github.com/documentationjs/documentation/compare/v9.0.0-alpha.1...v9.0.0) (2018-12-10)
|
146 |
|
147 |
|
148 | ### Features
|
149 |
|
150 | * Support for the logical assignment operator ([58d2a2f](https://github.com/documentationjs/documentation/commit/58d2a2f)), closes [#1172](https://github.com/documentationjs/documentation/issues/1172)
|
151 |
|
152 |
|
153 |
|
154 | <a name="9.0.0-alpha.1"></a>
|
155 | # [9.0.0-alpha.1](https://github.com/documentationjs/documentation/compare/v9.0.0-alpha.0...v9.0.0-alpha.1) (2018-10-24)
|
156 |
|
157 |
|
158 | ### Bug Fixes
|
159 |
|
160 | * **package:** update [@babel](https://github.com/babel)/parser to version 7.1.3 ([4dbb406](https://github.com/documentationjs/documentation/commit/4dbb406)), closes [#1145](https://github.com/documentationjs/documentation/issues/1145)
|
161 | * add node-resolve to module-deps ([a033547](https://github.com/documentationjs/documentation/commit/a033547))
|
162 | * add tests ([a4107dc](https://github.com/documentationjs/documentation/commit/a4107dc))
|
163 |
|
164 |
|
165 | ### Features
|
166 |
|
167 | * add support for node resolve algo ([ddd675d](https://github.com/documentationjs/documentation/commit/ddd675d))
|
168 |
|
169 |
|
170 |
|
171 | <a name="9.0.0-alpha.0"></a>
|
172 | # [9.0.0-alpha.0](https://github.com/documentationjs/documentation/compare/v8.1.2...v9.0.0-alpha.0) (2018-09-21)
|
173 |
|
174 |
|
175 | ### Features
|
176 |
|
177 | * Babel 7 support ([49c0f72](https://github.com/documentationjs/documentation/commit/49c0f72))
|
178 |
|
179 |
|
180 | ### BREAKING CHANGES
|
181 |
|
182 | * This moves documentation.js to Babel 7. From now on,
|
183 | documentation.js will only support Babel 7: please stick to older
|
184 | releases if you need to support Babel 6. Additionally, this work
|
185 | temporarily disables support for following dynamic imports.
|
186 |
|
187 |
|
188 |
|
189 | <a name="8.1.2"></a>
|
190 | ## [8.1.2](https://github.com/documentationjs/documentation/compare/v8.1.1...v8.1.2) (2018-08-23)
|
191 |
|
192 |
|
193 | ### Bug Fixes
|
194 |
|
195 | * membership infering for methods ([#1122](https://github.com/documentationjs/documentation/issues/1122)) ([40b1783](https://github.com/documentationjs/documentation/commit/40b1783))
|
196 |
|
197 |
|
198 |
|
199 | <a name="8.1.1"></a>
|
200 | ## [8.1.1](https://github.com/documentationjs/documentation/compare/v8.1.0...v8.1.1) (2018-08-17)
|
201 |
|
202 |
|
203 | ### Bug Fixes
|
204 |
|
205 | * Serve on correct port ([4d59f6f](https://github.com/documentationjs/documentation/commit/4d59f6f))
|
206 |
|
207 |
|
208 |
|
209 | <a name="8.1.0"></a>
|
210 | # [8.1.0](https://github.com/documentationjs/documentation/compare/v8.0.2...v8.1.0) (2018-08-03)
|
211 |
|
212 |
|
213 | ### Bug Fixes
|
214 |
|
215 | * **package:** update get-port to version 4.0.0 ([9ca8c06](https://github.com/documentationjs/documentation/commit/9ca8c06))
|
216 |
|
217 |
|
218 | ### Features
|
219 |
|
220 | * added project description ([45a9ea9](https://github.com/documentationjs/documentation/commit/45a9ea9))
|
221 |
|
222 |
|
223 |
|
224 | <a name="8.0.2"></a>
|
225 | ## [8.0.2](https://github.com/documentationjs/documentation/compare/v8.0.1...v8.0.2) (2018-07-20)
|
226 |
|
227 |
|
228 | ### Bug Fixes
|
229 |
|
230 | * **package:** update git-url-parse to version 10.0.1 ([91ade89](https://github.com/documentationjs/documentation/commit/91ade89))
|
231 |
|
232 |
|
233 |
|
234 | <a name="8.0.1"></a>
|
235 | ## [8.0.1](https://github.com/documentationjs/documentation/compare/v8.0.0...v8.0.1) (2018-07-16)
|
236 |
|
237 |
|
238 | ### Bug Fixes
|
239 |
|
240 | * **package:** update read-pkg-up to version 4.0.0 ([c700d3f](https://github.com/documentationjs/documentation/commit/c700d3f))
|
241 |
|
242 |
|
243 |
|
244 | <a name="8.0.0"></a>
|
245 | # [8.0.0](https://github.com/documentationjs/documentation/compare/v7.1.0...v8.0.0) (2018-06-04)
|
246 |
|
247 |
|
248 | ### Features
|
249 |
|
250 | * Semantic markdown headings ([#1087](https://github.com/documentationjs/documentation/issues/1087)) ([ca6217f](https://github.com/documentationjs/documentation/commit/ca6217f))
|
251 |
|
252 |
|
253 | ### BREAKING CHANGES
|
254 |
|
255 | * changes Markdown output
|
256 |
|
257 |
|
258 |
|
259 | <a name="7.1.0"></a>
|
260 | # [7.1.0](https://github.com/documentationjs/documentation/compare/v7.0.0...v7.1.0) (2018-05-26)
|
261 |
|
262 |
|
263 | ### Features
|
264 |
|
265 | * support flow comment types ([85d50f9](https://github.com/documentationjs/documentation/commit/85d50f9))
|
266 |
|
267 |
|
268 |
|
269 | <a name="7.0.0"></a>
|
270 | # [7.0.0](https://github.com/documentationjs/documentation/compare/v6.3.3...v7.0.0) (2018-05-22)
|
271 |
|
272 |
|
273 | ### Features
|
274 |
|
275 | * Auto-detect readme filename ([4fd776b](https://github.com/documentationjs/documentation/commit/4fd776b))
|
276 |
|
277 |
|
278 | ### BREAKING CHANGES
|
279 |
|
280 | * the --readme-file option now has a smart default value
|
281 |
|
282 |
|
283 |
|
284 | <a name="6.3.3"></a>
|
285 | ## [6.3.3](https://github.com/documentationjs/documentation/compare/v6.3.2...v6.3.3) (2018-05-14)
|
286 |
|
287 |
|
288 |
|
289 | <a name="6.3.2"></a>
|
290 | ## [6.3.2](https://github.com/documentationjs/documentation/compare/v6.3.1...v6.3.2) (2018-04-24)
|
291 |
|
292 |
|
293 | ### Bug Fixes
|
294 |
|
295 | * **vue:** Make vue parser tolerant of components that don't contain scripts ([#1061](https://github.com/documentationjs/documentation/issues/1061)) ([8f9bc7b](https://github.com/documentationjs/documentation/commit/8f9bc7b)), closes [#1060](https://github.com/documentationjs/documentation/issues/1060)
|
296 |
|
297 |
|
298 |
|
299 | <a name="6.3.1"></a>
|
300 | ## [6.3.1](https://github.com/documentationjs/documentation/compare/v6.3.0...v6.3.1) (2018-04-23)
|
301 |
|
302 |
|
303 | ### Bug Fixes
|
304 |
|
305 | * adding vue support broke tests that are not file based ([#1058](https://github.com/documentationjs/documentation/issues/1058)) ([9d7bd2e](https://github.com/documentationjs/documentation/commit/9d7bd2e)), closes [#1057](https://github.com/documentationjs/documentation/issues/1057)
|
306 |
|
307 |
|
308 |
|
309 | <a name="6.3.0"></a>
|
310 | # [6.3.0](https://github.com/documentationjs/documentation/compare/v6.2.0...v6.3.0) (2018-04-20)
|
311 |
|
312 |
|
313 | ### Bug Fixes
|
314 |
|
315 | * **package:** update git-url-parse to version 9.0.0 ([94a1fb6](https://github.com/documentationjs/documentation/commit/94a1fb6))
|
316 |
|
317 |
|
318 | ### Features
|
319 |
|
320 | * Vue Support ([f60d90c](https://github.com/documentationjs/documentation/commit/f60d90c))
|
321 |
|
322 |
|
323 |
|
324 | <a name="6.2.0"></a>
|
325 | # [6.2.0](https://github.com/documentationjs/documentation/compare/v6.1.0...v6.2.0) (2018-04-11)
|
326 |
|
327 |
|
328 | ### Bug Fixes
|
329 |
|
330 | * get rid of shelljs dependency ([630625d](https://github.com/documentationjs/documentation/commit/630625d))
|
331 |
|
332 |
|
333 | ### Features
|
334 |
|
335 | * **doctrine:** Support decorator syntax in examples ([b309d39](https://github.com/documentationjs/documentation/commit/b309d39)), closes [#1016](https://github.com/documentationjs/documentation/issues/1016)
|
336 | * **inferTypes:** Support class properties ([22d8740](https://github.com/documentationjs/documentation/commit/22d8740)), closes [#1043](https://github.com/documentationjs/documentation/issues/1043)
|
337 |
|
338 |
|
339 |
|
340 | <a name="6.1.0"></a>
|
341 | # [6.1.0](https://github.com/documentationjs/documentation/compare/v6.0.0...v6.1.0) (2018-03-08)
|
342 |
|
343 |
|
344 | ### Bug Fixes
|
345 |
|
346 | * lends with object property using literal key ([#1035](https://github.com/documentationjs/documentation/issues/1035)) ([99ad49b](https://github.com/documentationjs/documentation/commit/99ad49b))
|
347 |
|
348 |
|
349 | ### Features
|
350 |
|
351 | * Support class property [@type](https://github.com/type) tag ([#1028](https://github.com/documentationjs/documentation/issues/1028)) ([4ed5edf](https://github.com/documentationjs/documentation/commit/4ed5edf))
|
352 |
|
353 |
|
354 |
|
355 | <a name="6.0.0"></a>
|
356 | # [6.0.0](https://github.com/documentationjs/documentation/compare/v5.5.0...v6.0.0) (2018-03-02)
|
357 |
|
358 |
|
359 | ### Features
|
360 |
|
361 | * documentation.js now requires node v6 or newer. ([#1034](https://github.com/documentationjs/documentation/issues/1034)) ([ccce516](https://github.com/documentationjs/documentation/commit/ccce516))
|
362 |
|
363 |
|
364 | ### BREAKING CHANGES
|
365 |
|
366 | * documentation.js requires node v6 or newer.
|
367 |
|
368 |
|
369 |
|
370 | <a name="5.5.0"></a>
|
371 | # [5.5.0](https://github.com/documentationjs/documentation/compare/v5.4.0...v5.5.0) (2018-03-02)
|
372 |
|
373 |
|
374 | ### Bug Fixes
|
375 |
|
376 | * github links for [@typedef](https://github.com/typedef) comments should link to comment, not context ([#1024](https://github.com/documentationjs/documentation/issues/1024)) ([37a91b2](https://github.com/documentationjs/documentation/commit/37a91b2))
|
377 | * Make documentation.js compatible with node 4.x for one more version ([#1033](https://github.com/documentationjs/documentation/issues/1033)) ([5067ee0](https://github.com/documentationjs/documentation/commit/5067ee0))
|
378 |
|
379 |
|
380 | ### Features
|
381 |
|
382 | * Support `--shallow` argument for `lint` command. Closes [#956](https://github.com/documentationjs/documentation/issues/956) ([#995](https://github.com/documentationjs/documentation/issues/995)) ([64f660d](https://github.com/documentationjs/documentation/commit/64f660d))
|
383 | * Support the .mjs extension by default. ([#1023](https://github.com/documentationjs/documentation/issues/1023)) ([b8a7e0d](https://github.com/documentationjs/documentation/commit/b8a7e0d))
|
384 | * use reference links for Markdown output, improving brevity ([ab494dd](https://github.com/documentationjs/documentation/commit/ab494dd))
|
385 |
|
386 |
|
387 |
|
388 | <a name="5.4.0"></a>
|
389 | # [5.4.0](https://github.com/documentationjs/documentation/compare/v5.3.5...v5.4.0) (2018-02-10)
|
390 |
|
391 |
|
392 | ### Bug Fixes
|
393 |
|
394 | * **package:** update remark-toc to version 5.0.0 ([0bb3d0d](https://github.com/documentationjs/documentation/commit/0bb3d0d))
|
395 |
|
396 |
|
397 | ### Features
|
398 |
|
399 | * add support for class param declarations at the constructor ([#1013](https://github.com/documentationjs/documentation/issues/1013)) ([05c5279](https://github.com/documentationjs/documentation/commit/05c5279))
|
400 |
|
401 |
|
402 |
|
403 | <a name="5.3.5"></a>
|
404 | ## [5.3.5](https://github.com/documentationjs/documentation/compare/v5.3.4...v5.3.5) (2017-12-12)
|
405 |
|
406 |
|
407 | ### Bug Fixes
|
408 |
|
409 | * **globals-docs:** Remove en-US from MDN links. ([#973](https://github.com/documentationjs/documentation/issues/973)) ([aa661ff](https://github.com/documentationjs/documentation/commit/aa661ff)), closes [#964](https://github.com/documentationjs/documentation/issues/964)
|
410 |
|
411 |
|
412 |
|
413 | <a name="5.3.4"></a>
|
414 | ## [5.3.4](https://github.com/documentationjs/documentation/compare/v5.3.3...v5.3.4) (2017-12-12)
|
415 |
|
416 |
|
417 | ### Bug Fixes
|
418 |
|
419 | * **package:** update babelify to version 8.0.0 ([10dff6f](https://github.com/documentationjs/documentation/commit/10dff6f))
|
420 | * **package:** update read-pkg-up to version 3.0.0 ([d8fbf2c](https://github.com/documentationjs/documentation/commit/d8fbf2c))
|
421 | * **package:** update remark-html to version 7.0.0 ([9842814](https://github.com/documentationjs/documentation/commit/9842814))
|
422 | * **package:** update vinyl-fs to version 3.0.0 ([#966](https://github.com/documentationjs/documentation/issues/966)) ([1d6fe80](https://github.com/documentationjs/documentation/commit/1d6fe80))
|
423 |
|
424 |
|
425 |
|
426 | <a name="5.3.3"></a>
|
427 | ## [5.3.3](https://github.com/documentationjs/documentation/compare/v5.3.2...v5.3.3) (2017-10-12)
|
428 |
|
429 |
|
430 | ### Bug Fixes
|
431 |
|
432 | * **html:** Display all levels of parameter properties. ([#933](https://github.com/documentationjs/documentation/issues/933)) ([7a548eb](https://github.com/documentationjs/documentation/commit/7a548eb))
|
433 | * **package:** update github-slugger to version 1.2.0 ([2b74956](https://github.com/documentationjs/documentation/commit/2b74956))
|
434 | * Fix the split in HTML at 33/67% instead of calculating percentages ([#939](https://github.com/documentationjs/documentation/issues/939)) ([e4781eb](https://github.com/documentationjs/documentation/commit/e4781eb)), closes [#927](https://github.com/documentationjs/documentation/issues/927)
|
435 |
|
436 |
|
437 |
|
438 | <a name="5.3.2"></a>
|
439 | ## [5.3.2](https://github.com/documentationjs/documentation/compare/v5.3.1...v5.3.2) (2017-09-15)
|
440 |
|
441 |
|
442 | ### Bug Fixes
|
443 |
|
444 | * special property names in flowtypes ([7fc6ca8](https://github.com/documentationjs/documentation/commit/7fc6ca8))
|
445 |
|
446 |
|
447 |
|
448 | <a name="5.3.1"></a>
|
449 | ## [5.3.1](https://github.com/documentationjs/documentation/compare/v5.3.0...v5.3.1) (2017-09-07)
|
450 |
|
451 |
|
452 | ### Bug Fixes
|
453 |
|
454 | * cover more hideconstructor cases ([5bdbf1f](https://github.com/documentationjs/documentation/commit/5bdbf1f))
|
455 | * Enable dynamicImport plugin to support import() syntax ([#903](https://github.com/documentationjs/documentation/issues/903)) ([b97241f](https://github.com/documentationjs/documentation/commit/b97241f)), closes [#902](https://github.com/documentationjs/documentation/issues/902)
|
456 | * regression in toc causing crash ([125a577](https://github.com/documentationjs/documentation/commit/125a577))
|
457 |
|
458 |
|
459 |
|
460 | <a name="5.3.0"></a>
|
461 | # [5.3.0](https://github.com/documentationjs/documentation/compare/v5.2.2...v5.3.0) (2017-09-04)
|
462 |
|
463 |
|
464 | ### Bug Fixes
|
465 |
|
466 | * [@name](https://github.com/name) tag disconnects comment ([#897](https://github.com/documentationjs/documentation/issues/897)) ([a04b6fd](https://github.com/documentationjs/documentation/commit/a04b6fd))
|
467 |
|
468 |
|
469 | ### Features
|
470 |
|
471 | * groups in toc ([#895](https://github.com/documentationjs/documentation/issues/895)) ([c94412a](https://github.com/documentationjs/documentation/commit/c94412a))
|
472 | * implement [@hideconstructor](https://github.com/hideconstructor) ([#898](https://github.com/documentationjs/documentation/issues/898)) ([7a07d51](https://github.com/documentationjs/documentation/commit/7a07d51))
|
473 |
|
474 |
|
475 |
|
476 | <a name="5.2.2"></a>
|
477 | ## [5.2.2](https://github.com/documentationjs/documentation/compare/v5.2.1...v5.2.2) (2017-08-22)
|
478 |
|
479 |
|
480 | ### Bug Fixes
|
481 |
|
482 | * **$compile:** prevent babel from transpiling non-module scripts in default_theme's assets ([1286a1f](https://github.com/documentationjs/documentation/commit/1286a1f))
|
483 |
|
484 |
|
485 |
|
486 | <a name="5.2.1"></a>
|
487 | ## [5.2.1](https://github.com/documentationjs/documentation/compare/v5.2.0...v5.2.1) (2017-08-12)
|
488 |
|
489 |
|
490 |
|
491 | <a name="5.2.0"></a>
|
492 | # [5.2.0](https://github.com/documentationjs/documentation/compare/v5.1.1...v5.2.0) (2017-08-09)
|
493 |
|
494 |
|
495 | ### Bug Fixes
|
496 |
|
497 | * alphabetical sort and add flow notation to sort file ([#861](https://github.com/documentationjs/documentation/issues/861)) ([aa3496a](https://github.com/documentationjs/documentation/commit/aa3496a)), closes [#838](https://github.com/documentationjs/documentation/issues/838)
|
498 | * make html and markdown second option optional ([#871](https://github.com/documentationjs/documentation/issues/871)) ([0324865](https://github.com/documentationjs/documentation/commit/0324865)), closes [#869](https://github.com/documentationjs/documentation/issues/869)
|
499 |
|
500 |
|
501 | ### Features
|
502 |
|
503 | * convert Flow's ThisTypeAnnotation to a doctrine NameExpression ([#870](https://github.com/documentationjs/documentation/issues/870)) ([23aa981](https://github.com/documentationjs/documentation/commit/23aa981))
|
504 |
|
505 |
|
506 |
|
507 | <a name="5.1.1"></a>
|
508 | ## [5.1.1](https://github.com/documentationjs/documentation/compare/v5.1.0...v5.1.1) (2017-08-04)
|
509 |
|
510 |
|
511 | ### Bug Fixes
|
512 |
|
513 | * **theme:** Remove dead stepsibling navigation code ([dccb151](https://github.com/documentationjs/documentation/commit/dccb151))
|
514 | * cli options should override package.json options ([ecf16bd](https://github.com/documentationjs/documentation/commit/ecf16bd)), closes [#845](https://github.com/documentationjs/documentation/issues/845)
|
515 |
|
516 |
|
517 |
|
518 | <a name="5.1.0"></a>
|
519 | # [5.1.0](https://github.com/documentationjs/documentation/compare/v5.0.1...v5.1.0) (2017-07-31)
|
520 |
|
521 |
|
522 | ### Bug Fixes
|
523 |
|
524 | * **scripts:** Remove changelog package.json task ([dddac19](https://github.com/documentationjs/documentation/commit/dddac19))
|
525 |
|
526 |
|
527 | ### Features
|
528 |
|
529 | * **theme:** Flexible sidebar for default theme ([6509ae8](https://github.com/documentationjs/documentation/commit/6509ae8))
|
530 |
|
531 |
|
532 |
|
533 | <a name="5.0.1"></a>
|
534 | ## [5.0.1](https://github.com/documentationjs/documentation/compare/v5.0.0...v5.0.1) (2017-07-28)
|
535 |
|
536 |
|
537 |
|
538 | <a name="5.0.0"></a>
|
539 | # [5.0.0](https://github.com/documentationjs/documentation/compare/v4.0.0...v5.0.0) (2017-07-27)
|
540 |
|
541 |
|
542 | ### Reverts
|
543 |
|
544 | * **polyglot:** Remove polyglot mode ([5b373ff](https://github.com/documentationjs/documentation/commit/5b373ff)), closes [#850](https://github.com/documentationjs/documentation/issues/850) [#731](https://github.com/documentationjs/documentation/issues/731) [#702](https://github.com/documentationjs/documentation/issues/702) [#132](https://github.com/documentationjs/documentation/issues/132)
|
545 |
|
546 |
|
547 | ### BREAKING CHANGES
|
548 |
|
549 | * **polyglot:** I'd like to still support C++ and other languages in the future! But I'm much
|
550 | happier doing so by separating the extraction & input phases to the degree that documentation.js can
|
551 | read the output of another module that extracts JSDoc comments from C++ code, rather than having CPP
|
552 | support in it.
|
553 |
|
554 |
|
555 |
|
556 | <a name="4.0.0"></a>
|
557 | # [4.0.0](https://github.com/documentationjs/documentation/compare/v4.0.0-rc.1...v4.0.0) (2017-07-27)
|
558 |
|
559 |
|
560 | ### Bug Fixes
|
561 |
|
562 | * **html output:** Fix links between navigation and items in HTML documentation ([5fb77bc](https://github.com/documentationjs/documentation/commit/5fb77bc))
|
563 | * **package:** update babel-generator to version 6.25.0 ([#804](https://github.com/documentationjs/documentation/issues/804)) ([65f5a37](https://github.com/documentationjs/documentation/commit/65f5a37))
|
564 | * **package:** update chalk to version 2.0.0 ([#833](https://github.com/documentationjs/documentation/issues/833)) ([2329db4](https://github.com/documentationjs/documentation/commit/2329db4))
|
565 | * **package:** update github-slugger to version 1.1.3 ([#793](https://github.com/documentationjs/documentation/issues/793)) ([74392cc](https://github.com/documentationjs/documentation/commit/74392cc))
|
566 | * Show () for callbacks ([61968c7](https://github.com/documentationjs/documentation/commit/61968c7))
|
567 | * **package:** update micromatch to version 3.0.0 ([#792](https://github.com/documentationjs/documentation/issues/792)) ([3f2bf90](https://github.com/documentationjs/documentation/commit/3f2bf90))
|
568 | * **package:** update remark to version 8.0.0 ([1ae8136](https://github.com/documentationjs/documentation/commit/1ae8136))
|
569 | * Fix filtering in the default theme ([473f317](https://github.com/documentationjs/documentation/commit/473f317))
|
570 | * Report nesting errors instead of throwing them as errors ([ea69608](https://github.com/documentationjs/documentation/commit/ea69608)), closes [#832](https://github.com/documentationjs/documentation/issues/832)
|
571 | * **package:** update remark-html to version 6.0.1 ([#815](https://github.com/documentationjs/documentation/issues/815)) ([e472550](https://github.com/documentationjs/documentation/commit/e472550))
|
572 | * **package:** update vfile-reporter to version 4.0.0 ([a3e1fb8](https://github.com/documentationjs/documentation/commit/a3e1fb8))
|
573 |
|
574 |
|
575 |
|
576 | <a name="4.0.0-rc.1"></a>
|
577 | # [4.0.0-rc.1](https://github.com/documentationjs/documentation/compare/v4.0.0-rc.0...v4.0.0-rc.1) (2017-05-01)
|
578 |
|
579 |
|
580 | ### Bug Fixes
|
581 |
|
582 | * Infer parameters for classes from constructors ([355038d](https://github.com/documentationjs/documentation/commit/355038d)), closes [#689](https://github.com/documentationjs/documentation/issues/689)
|
583 | * **document-exported:** Ensure that document-exported does not document constructors separately ([96a6d13](https://github.com/documentationjs/documentation/commit/96a6d13))
|
584 | * **flow:** Fix inference of Flow types with properties ([#751](https://github.com/documentationjs/documentation/issues/751)) ([7c00acc](https://github.com/documentationjs/documentation/commit/7c00acc)), closes [#749](https://github.com/documentationjs/documentation/issues/749)
|
585 | * **params:** Parameters with default use = not ? ([3cc4426](https://github.com/documentationjs/documentation/commit/3cc4426)), closes [#737](https://github.com/documentationjs/documentation/issues/737)
|
586 |
|
587 |
|
588 | ### Features
|
589 |
|
590 | * **lint:** Identify explicit tags that don't match inference in lint stage ([ed5c2a0](https://github.com/documentationjs/documentation/commit/ed5c2a0))
|
591 |
|
592 |
|
593 |
|
594 | <a name="4.0.0-rc.0"></a>
|
595 | # [4.0.0-rc.0](https://github.com/documentationjs/documentation/compare/v4.0.0-beta.19...v4.0.0-rc.0) (2017-04-21)
|
596 |
|
597 |
|
598 | ### Bug Fixes
|
599 |
|
600 | * **html output:** Fix github links in HTML output ([#745](https://github.com/documentationjs/documentation/issues/745)) ([9554b2f](https://github.com/documentationjs/documentation/commit/9554b2f)), closes [#738](https://github.com/documentationjs/documentation/issues/738)
|
601 | * **params:** added code path for type RestElement ([6961ee8](https://github.com/documentationjs/documentation/commit/6961ee8))
|
602 |
|
603 |
|
604 | ### Code Refactoring
|
605 |
|
606 | * **nest:** Better nesting implementation ([#732](https://github.com/documentationjs/documentation/issues/732)) ([7374730](https://github.com/documentationjs/documentation/commit/7374730))
|
607 |
|
608 |
|
609 | ### BREAKING CHANGES
|
610 |
|
611 | * **nest:** referencing inferred destructure params without
|
612 | renaming them, like $0.x, from JSDoc comments will no longer
|
613 | work. To reference them, instead add a param tag to name the
|
614 | destructuring param, and then refer to members of that name.
|
615 |
|
616 | Before:
|
617 |
|
618 | ```js
|
619 | /**
|
620 | * @param {number} $0.x a member of x
|
621 | */
|
622 | function a({ x }) {}
|
623 | ```
|
624 |
|
625 | After:
|
626 |
|
627 | ```js
|
628 | /**
|
629 | * @param {Object} options
|
630 | * @param {number} options.x a member of x
|
631 | */
|
632 | function a({ x }) {}
|
633 | ```
|
634 |
|
635 | * Address review comments
|
636 |
|
637 | * Reduce testing node requirement back down to 4
|
638 |
|
639 | * Don't output empty properties, reduce diff noise
|
640 |
|
641 | * Rearrange and document params
|
642 |
|
643 | * Simplify param inference, update test fixtures. This is focused around Array destructuring: documenting destructured array elements with indices instead of names, because the names are purely internal details
|
644 |
|
645 | * Use temporary fork to get through blocker
|
646 |
|
647 |
|
648 |
|
649 | <a name="4.0.0-beta.19"></a>
|
650 | # [4.0.0-beta.19](https://github.com/documentationjs/documentation/compare/v4.0.0-beta.18...v4.0.0-beta.19) (2017-04-10)
|
651 |
|
652 |
|
653 | ### Bug Fixes
|
654 |
|
655 | * **inference:** Refactor membership inference ([84c9215](https://github.com/documentationjs/documentation/commit/84c9215))
|
656 | * **inference:** Robust parsing for shorthand object methods ([802dc4c](https://github.com/documentationjs/documentation/commit/802dc4c))
|
657 | * **scopes:** Support inner scope ([#665](https://github.com/documentationjs/documentation/issues/665)) ([8cc34b6](https://github.com/documentationjs/documentation/commit/8cc34b6))
|
658 |
|
659 |
|
660 | ### Features
|
661 |
|
662 | * **core:** Support Flow interface declarations ([e2915dc](https://github.com/documentationjs/documentation/commit/e2915dc))
|
663 | * **core:** Switch to Promises everywhere. Adopt Node v4 ES6 ([#648](https://github.com/documentationjs/documentation/issues/648)) ([631c692](https://github.com/documentationjs/documentation/commit/631c692))
|
664 | * **markdown:** Add `[@see](https://github.com/see)` tag output in Markdown ([#682](https://github.com/documentationjs/documentation/issues/682)) ([f07285a](https://github.com/documentationjs/documentation/commit/f07285a))
|
665 |
|
666 |
|
667 |
|
668 | <a name="4.0.0-beta.18"></a>
|
669 | # [4.0.0-beta.18](https://github.com/documentationjs/documentation/compare/v4.0.0-beta.17...v4.0.0-beta.18) (2016-12-29)
|
670 |
|
671 |
|
672 | ### Bug Fixes
|
673 |
|
674 | * **cli:** Fix error reporting in the CLI ([88c8f9a](https://github.com/documentationjs/documentation/commit/88c8f9a))
|
675 | * **markdown:** Start headings in Markdown at h2 (#644) ([2ae5d8f](https://github.com/documentationjs/documentation/commit/2ae5d8f))
|
676 |
|
677 | ### Features
|
678 |
|
679 | * **bin:** Support globs on windows and use smarter recursion (#629) ([cb8fdfa](https://github.com/documentationjs/documentation/commit/cb8fdfa)), closes [#607](https://github.com/documentationjs/documentation/issues/607)
|
680 | * **markdown:** Add table of contents support for Markdown mode (#645) ([4c66fb1](https://github.com/documentationjs/documentation/commit/4c66fb1))
|
681 |
|
682 | ### Performance Improvements
|
683 |
|
684 | * **dependencies:** Move standard-changelog to devDependencies (#636) ([7a66b3f](https://github.com/documentationjs/documentation/commit/7a66b3f))
|
685 |
|
686 |
|
687 |
|
688 | <a name="4.0.0-beta.17"></a>
|
689 | # [4.0.0-beta.17](https://github.com/documentationjs/documentation/compare/v4.0.0-beta16...v4.0.0-beta.17) (2016-12-23)
|
690 |
|
691 | This release also fixes a mistake I was making with semver: pre-v4 beta
|
692 | releases will be called `beta.17` and `beta.18` and so on, rather than
|
693 | non-standard `beta16` without the `.`.
|
694 |
|
695 |
|
696 | ### Bug Fixes
|
697 |
|
698 | * **hierarchy:** collect events from static and instance members (#628) ([f1e0267](https://github.com/documentationjs/documentation/commit/f1e0267)), closes [#486](https://github.com/documentationjs/documentation/issues/486)
|
699 |
|
700 |
|
701 |
|
702 | <a name="4.0.0-beta16"></a>
|
703 | # [4.0.0-beta16](https://github.com/documentationjs/documentation/compare/v4.0.0-beta15...v4.0.0-beta16) (2016-12-07)
|
704 |
|
705 |
|
706 | ### Bug Fixes
|
707 |
|
708 | * **bin:** Remove dead code in documentation.js command (#627) ([ab16a20](https://github.com/documentationjs/documentation/commit/ab16a20))
|
709 | * **extractors:** Document export default value (#623) ([363a108](https://github.com/documentationjs/documentation/commit/363a108)), closes [#543](https://github.com/documentationjs/documentation/issues/543)
|
710 | * **parser:** Avoid error about deoptimization on very large files (#621) ([846ab94](https://github.com/documentationjs/documentation/commit/846ab94))
|
711 |
|
712 | ### Features
|
713 |
|
714 | * **build:** load passed in config option (#625) ([89fb67f](https://github.com/documentationjs/documentation/commit/89fb67f))
|
715 | * **output:** Display type information for typedefs in Markdown and HTML ([8b04029](https://github.com/documentationjs/documentation/commit/8b04029))
|
716 |
|
717 |
|
718 |
|
719 |
|
720 | <a name="4.0.0-beta15"></a>
|
721 | # [4.0.0-beta15](https://github.com/documentationjs/documentation/compare/v4.0.0-beta14...v4.0.0-beta15) (2016-11-23)
|
722 |
|
723 | ### Fixes
|
724 |
|
725 | * Infer class augments tag in cases like `Foo extends React.Component`
|
726 |
|
727 | ### Features
|
728 |
|
729 | * **config:** add file property for notes ([#614](https://github.com/documentationjs/documentation/issues/614)) ([d96aa47](https://github.com/documentationjs/documentation/commit/d96aa47)), closes [#609](https://github.com/documentationjs/documentation/issues/609)
|
730 |
|
731 |
|
732 |
|
733 | ## 4.0.0-beta14
|
734 |
|
735 | * Highlight all Markdown, not just examples. Fixes #610
|
736 | * Fix for `--config` only strip comments on json files (#611)
|
737 | * Merge inferred return type like we do for params. Refs #359 (#604)
|
738 | * Support webpack's System.import with nice handy babel plugin (#603)
|
739 | * Format optional types with ? instead of [] (#538)
|
740 | * Fix membership assignment for old-fashioned prototype members (#599)
|
741 | * Update Node API documentation to include only exposed API surface
|
742 | * Add too-much-inference troubleshooting topic
|
743 |
|
744 | ## 4.0.0-beta13
|
745 |
|
746 | * Fix linker null reference error
|
747 |
|
748 | ## 4.0.0-beta12
|
749 |
|
750 | * Update Doctrine to handle more JSDoc types
|
751 | * Fix ReferenceError in default theme
|
752 | * Show GitHub link for nested elements in default theme
|
753 | * Fix linking resolution order
|
754 |
|
755 | ## 4.0.0-beta11
|
756 |
|
757 | * Improved support for Flow: function types, object types, mixed types, null,
|
758 | void, typedefs
|
759 | * New option: [sort-order](https://github.com/documentationjs/documentation/pull/535)
|
760 | * Updates to Babylon 6.10.x
|
761 | * Updates to dependencies, including yargs.
|
762 | * [`document-exported` now traverses only exported code](https://github.com/documentationjs/documentation/pull/533).
|
763 |
|
764 | ## 4.0.0-beta10
|
765 |
|
766 | * Lower memory consumption when dealing with large codebases
|
767 | * Better support for detecting names and kinds of ES6-exported values
|
768 | * New `document-exported` flag allows you to automatically document
|
769 | ES6-exported values, without even a comment! [490](https://github.com/documentationjs/documentation/pull/490)
|
770 |
|
771 | ## 4.0.0-beta5
|
772 |
|
773 | * Add decorator support (zacharygolba)
|
774 | * Add support to infer whether functions are private based on their name,
|
775 | like starting with `_` (arv)
|
776 | * Improve internal documentation
|
777 |
|
778 | ## 4.0.0-beta4
|
779 |
|
780 | * Fix minor dependency mistake
|
781 |
|
782 | ## 4.0.0-beta3
|
783 |
|
784 | * Updates theme to a much-improved design
|
785 | * Fix augments tag display in HTML
|
786 | * Improve name detection of ES6-exported methods and variables
|
787 | * Allow documentation of Object.prototype methods
|
788 |
|
789 | ## 4.0.0-beta2
|
790 |
|
791 | Minor fixes
|
792 |
|
793 | * Fixes `export { foo } from './bar'` style export
|
794 | * Fixed CLI usage examples to simply say `documentation` instead of `/usr/bin/documentation` or
|
795 | similar.
|
796 |
|
797 | ## 4.0.0-beta1
|
798 |
|
799 | **Now using Babel 6!**
|
800 |
|
801 | Much long-awaited upgrade makes documentation.js compatible with fresh
|
802 | new Babel-using codebases.
|
803 |
|
804 | And also:
|
805 |
|
806 | * GitHub Enterprise support
|
807 | * New tag support: abstract, override, readonly, interface, variation, see, todo
|
808 | (only in parsing phase, not yet in all outputs)
|
809 | * Parses jsx and es6 extensions by default, as well as .js
|
810 | * Fixes polyglot mode
|
811 | * Now shows the `@throws` tag content in Markdown output
|
812 | * Support for example captions
|
813 |
|
814 | ## 4.0.0-beta
|
815 |
|
816 | **Revitalized documentation.js command line interface!**
|
817 |
|
818 | The `documentation` utility now takes commands:
|
819 |
|
820 | * `documentation build` extracts and formats documentation
|
821 | * `documentation serve` provides an auto-reloading server ([#236](https://github.com/documentationjs/documentation/pull/236))
|
822 | * `documentation lint` reviews files for inconsistencies
|
823 | * `documentation readme` patches API documentation into a readme ([#313](https://github.com/documentationjs/documentation/pull/313) by @anandthakker)
|
824 |
|
825 | This functionality was previously included in `dev-documentation` and has
|
826 | been folded into `documentation` proper.
|
827 |
|
828 | **Much more flexible themes**
|
829 |
|
830 | Themes are now much more customizable. In documentation.js 3.x and before, themes
|
831 | were required to use Handlebars templates and produce a single page. In
|
832 | documentation.js 4.x and beyond, they are JavaScript modules that can use
|
833 | any template engine and produce any number of files. See the
|
834 | [new theme documentation](https://github.com/documentationjs/documentation/blob/master/docs/THEMING.md) for
|
835 | details.
|
836 |
|
837 | **More precise traversal**
|
838 |
|
839 | Inference in 4.x is stricter than in 3.x: comments must be adjacent
|
840 | to the statements they document. This should make documentation generation
|
841 | much more predictable.
|
842 |
|
843 | **Support for the revealing module pattern**
|
844 |
|
845 | ```js
|
846 | /** Foo */
|
847 | function Foo() {
|
848 | /** Test */
|
849 | function bar() {}
|
850 | return {
|
851 | bar: bar
|
852 | };
|
853 | }
|
854 | ````
|
855 |
|
856 | New support for the [JavaScript module pattern](http://www.macwright.org/2012/06/04/the-module-pattern.html)!
|
857 | This was implemented in [#324](https://github.com/documentationjs/documentation/pull/324)
|
858 | by [Charlie Brown](https://github.com/carbonrobot).
|
859 |
|
860 | **Breaking changes**
|
861 |
|
862 | * documentation.js now follows the [JSDoc standard's interpretation of the @name tag](http://usejsdoc.org/tags-name.html):
|
863 | specifying a name tag will turn off inference. If you still want inference
|
864 | but want to call code something else, use the [@alias tag](http://usejsdoc.org/tags-alias.html) instead.
|
865 |
|
866 | ## 3.0.4
|
867 |
|
868 | * Allow parameter types to be mixed into explicit parameter documentation. (#239 and #232)
|
869 | * Support GitHub links in Markdown output (#238)
|
870 |
|
871 | ## 3.0.3
|
872 |
|
873 | * Infer typedefs from Flow type aliases. Fixes #227
|
874 | * Fix type-annotated rest expressions, raised in #230
|
875 |
|
876 | ## 3.0.2
|
877 |
|
878 | * Infer rest parameters. Fixes #223
|
879 | * Avoid filtering comments in lint mode. Fixes #186
|
880 | * Nest both properties and params. Fixes #164
|
881 |
|
882 | ## 3.0.1
|
883 |
|
884 | * BUGFIX: Fix default theme resolution [#212](https://github.com/documentationjs/documentation/pull/212)
|
885 |
|
886 | ## 3.0.0
|
887 |
|
888 | The largest change to documentation.js so far.
|
889 |
|
890 | **Dropping streams**
|
891 |
|
892 | This a major refactor of the documentation.js interface with a focus on
|
893 | simplifying the system. Up until this point, documentation.js was built around
|
894 | [node.js streams](https://nodejs.org/api/stream.html), which are low-level
|
895 | representations of asynchronous series of data. While this abstraction was
|
896 | appropriate for the input and github streams, which are asynchronous, the
|
897 | majority of documentation.js's internals are simple and synchronous functions
|
898 | for which basic functional composition makes more sense than stream
|
899 | semantics.
|
900 |
|
901 | Documentation 3.0.0 uses simple functional composition for operations like
|
902 | parmameter inference, rather than streams.
|
903 |
|
904 | **Stronger support for ES6, ES7, and Flow**
|
905 |
|
906 | We've switched to [Babel](https://babeljs.io/) as our source code parser,
|
907 | which means that we have much broader support of new JavaScript features,
|
908 | including import/export syntax and new features in ES6.
|
909 |
|
910 | Babel also parses [Flow type annotations](http://flowtype.org/docs/type-annotations.html),
|
911 | and new inference code means that we can infer
|
912 |
|
913 | * Parameter names & types
|
914 | * Return types
|
915 |
|
916 | Without any explicit JSDoc tags. This means that for many simple functions,
|
917 | we can generate great documentation with less writing.
|
918 |
|
919 | **Stronger module support**
|
920 |
|
921 | Documentation.js now has much better inference for membership and names of symbols
|
922 | exported via `exports` or `module.exports`.
|
923 |
|
924 | **Support for nested symbols**
|
925 |
|
926 | The parent/child relationship between symbols is now fully hierarchical, and
|
927 | symbols can be nested to any depth. For instance:
|
928 |
|
929 | ```
|
930 | /**
|
931 | * A global Parent class.
|
932 | */
|
933 | var Parent = function () {};
|
934 |
|
935 | /**
|
936 | * A Child class.
|
937 | */
|
938 | Parent.Child = function () {};
|
939 |
|
940 | /**
|
941 | * A Grandchild class.
|
942 | */
|
943 | Parent.Child.Grandchild = function () {};
|
944 | ```
|
945 |
|
946 | In addition, filtering by access is now applied to the entire hierarchy: if you
|
947 | mark a class as `@private`, neither it nor its children will be included in the
|
948 | output by default, regardless of the access specifiers of the children.
|
949 |
|
950 | **mdast-based Markdown output**
|
951 |
|
952 | We've switched from templating Markdown output with [Handlebars.js](http://handlebarsjs.com/)
|
953 | to generating an [abstract syntax tree](https://en.wikipedia.org/wiki/Abstract_syntax_tree)
|
954 | of desired output and stringifying it with [mdast](https://github.com/wooorm/mdast).
|
955 | This lets documentation.js output complex Markdown without having to worry
|
956 | about escaping and properly formatting certain elements.
|
957 |
|
958 | **Test coverage 100%**
|
959 |
|
960 | documentation.js returns to 100% test coverage, so every single line
|
961 | of code is covered by our large library of text fixtures and specific tests.
|
962 |
|
963 | **--lint mode**
|
964 |
|
965 | Specifying the `--lint` flag makes documentation.js check for non-standard
|
966 | types, like `String`, or missing namespaces. If the encountered files have
|
967 | any problems, it pretty-prints helpful debug messages and exits with status 1,
|
968 | and otherwise exits with no output and status 0.
|
969 |
|
970 | **Breaking changes**
|
971 |
|
972 | * The `--version` flag is now `--project-version`. `--version` now outputs
|
973 | documentation.js's version
|
974 |
|
975 | ## 2.0.1
|
976 |
|
977 | * Fixes `@param` tags that refer to properties of unmentioned objects: these
|
978 | will warn instead of crashing. For instance, `/** @param {boolean} foo.bar */`.
|
979 | * Expose `--shallow` option in CLI
|
980 |
|
981 | ## 2.0.0
|
982 |
|
983 | * Breaking: Removes `docset` support from documentation.js: this will be supported
|
984 | by a 3rd party tool in the future. This removal means that we no longer have
|
985 | node-sqlite3 as a dependency, and documentation can be installed on systems
|
986 | without a compile toolchain.
|
987 | * JSDoc parse errors are now printed to stderr.
|
988 | * Parameter tags that document sub-parameters, such as `@param {Type} options.option`,
|
989 | are now nested under their parent parameter.
|
990 | * HTML output now includes events.
|
991 | * Error messages now include source file name and line number.
|
992 | * @typedef names are now inferred correctly.
|
993 |
|
994 | ## 1.4.0
|
995 |
|
996 | * Output for the `@throws` tag.
|
997 | * Output in HTML for the `@properties` tag.
|
998 |
|
999 | ## 1.3.0
|
1000 |
|
1001 | * Now infers `name` from `class` and `event` tags
|
1002 | * Support for documenting C++ code with the `polyglot` option and `--polyglot` CLI option
|
1003 | * Fixed github linking
|
1004 | * Support for [JSDoc3-style bracketed optional parameters](http://usejsdoc.org/tags-param.html#optional-parameters-and-default-values), like
|
1005 |
|
1006 | ```js
|
1007 | /**
|
1008 | * @param {Type} [param=defaultValue]
|
1009 | */
|
1010 | ```
|
1011 |
|
1012 | ## 1.2.0
|
1013 |
|
1014 | * Transforms in package.json `browserify.transform` fields are now applied to
|
1015 | source code so that babel, etc can be supported.
|
1016 | * Fixes crash caused by requiring JSON files
|
1017 |
|
1018 | ## 1.1.0
|
1019 |
|
1020 | * Add `external` option that allows the user to whitelist specific external
|
1021 | modules to be included in with documentation.
|
1022 |
|
1023 | ## 1.0.7
|
1024 |
|
1025 | * Fixes sorting order of documentation
|
1026 | * Switches order of static and instance members in output
|