|
1 |
| -## 4.0.0 |
| 1 | +## 4.0.0-beta |
2 | 2 |
|
3 | 3 | **Revitalized documentation.js command line interface!**
|
4 | 4 |
|
5 | 5 | The `documentation` utility now takes commands:
|
6 | 6 |
|
7 | 7 | * `documentation build` extracts and formats documentation
|
8 |
| -* `documentation serve` provides an auto-reloading server |
| 8 | +* `documentation serve` provides an auto-reloading server ([#236](https://github.com/documentationjs/documentation/pull/236)) |
9 | 9 | * `documentation lint` reviews files for inconsistencies
|
| 10 | +* `documentation readme` patches API documentation into a readme ([#313](https://github.com/documentationjs/documentation/pull/313) by @anandthakker) |
10 | 11 |
|
11 | 12 | This functionality was previously included in `dev-documentation` and has
|
12 | 13 | been folded into `documentation` proper.
|
13 | 14 |
|
| 15 | +**Much more flexible themes** |
| 16 | + |
| 17 | +Themes are now much more customizable. In documentation.js 3.x and before, themes |
| 18 | +were required to use Handlebars templates and produce a single page. In |
| 19 | +documentation.js 4.x and beyond, they are JavaScript modules that can use |
| 20 | +any template engine and produce any number of files. See the |
| 21 | +[new theme documentation](https://github.com/documentationjs/documentation/blob/master/docs/THEMING.md) for |
| 22 | +details. |
| 23 | + |
| 24 | +**More precise traversal** |
| 25 | + |
| 26 | +Inference in 4.x is stricter than in 3.x: comments must be adjacent |
| 27 | +to the statements they document. This should make documentation generation |
| 28 | +much more predictable. |
| 29 | + |
| 30 | +**Support for the revealing module pattern** |
| 31 | + |
| 32 | +```js |
| 33 | +/** Foo */ |
| 34 | +function Foo() { |
| 35 | + /** Test */ |
| 36 | + function bar() {} |
| 37 | + return { |
| 38 | + bar: bar |
| 39 | + }; |
| 40 | +} |
| 41 | +```` |
| 42 | + |
| 43 | +New support for the [JavaScript module pattern](http://www.macwright.org/2012/06/04/the-module-pattern.html)! |
| 44 | +This was implemented in [#324](https://github.com/documentationjs/documentation/pull/324) |
| 45 | +by [Charlie Brown](https://github.com/carbonrobot). |
| 46 | + |
| 47 | +**Breaking changes** |
| 48 | + |
| 49 | +* documentation.js now follows the [JSDoc standard's interpretation of the @name tag](http://usejsdoc.org/tags-name.html): |
| 50 | + specifying a name tag will turn off inference. If you still want inference |
| 51 | + but want to call code something else, use the [@alias tag](http://usejsdoc.org/tags-alias.html) instead. |
| 52 | +
|
14 | 53 | ## 3.0.4
|
15 | 54 |
|
16 | 55 | * Allow parameter types to be mixed into explicit parameter documentation. (#239 and #232)
|
|
0 commit comments