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