Skip to content

Commit 54d4316

Browse files
committed
Fill out changelog for 4.0.0-beta
1 parent 50a6e55 commit 54d4316

File tree

1 file changed

+41
-2
lines changed

1 file changed

+41
-2
lines changed

CHANGELOG.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,55 @@
1-
## 4.0.0
1+
## 4.0.0-beta
22

33
**Revitalized documentation.js command line interface!**
44

55
The `documentation` utility now takes commands:
66

77
* `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))
99
* `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)
1011

1112
This functionality was previously included in `dev-documentation` and has
1213
been folded into `documentation` proper.
1314

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+
1453
## 3.0.4
1554
1655
* Allow parameter types to be mixed into explicit parameter documentation. (#239 and #232)

0 commit comments

Comments
 (0)