* refactor(nest): Better nesting implementation
This nesting implementation uses a proper recursive tree algorithm
Fixes https://github.com/documentationjs/documentation/issues/554
BREAKING CHANGE: referencing inferred destructure params without
renaming them, like $0.x, from JSDoc comments will no longer
work. To reference them, instead add a param tag to name the
destructuring param, and then refer to members of that name.
Before:
```js
/**
* @param {number} $0.x a member of x
*/
function a({ x }) {}
```
After:
```js
/**
* @param {Object} options
* @param {number} options.x a member of x
*/
function a({ x }) {}
```
* Address review comments
* Reduce testing node requirement back down to 4
* Don't output empty properties, reduce diff noise
* Rearrange and document params
* 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
* Use temporary fork to get through blocker
* Add support for interface declarations
* Support exported interfaces/type aliases
* Update test fixtures
* Add interface type, fix test
* Fix comment style and typo
* Fixed find_git test for windows platform.
* Fixed github test on windows platform.
* Fixed bin tests which are executed process from node.js
* On windows platform uses DOUBLE EXCLAMATION MARK instead of WARNING SIGN.
- Tags with `@lends` are now filtered out early on, so they never
generate documentation. Lends tags are structural hints only.
- Uses built-in type checks instead of babel-types where appropriate.
- More internal documentation
- Now reuses code for parsing lends between different forms
Previously broken syntax, now working:
```js
/** parent */
export default function() {
/** child */
this.a = 1;
}
```
This allows `type T = number => string`. Previously we were only
handling `type T = (x: number) => string` correctly.
Followup to #672 that:
- Adds a test fixture
- Fixes lint errors
If no parameter name exists in a function type, then set it to empty. Also,
fix the formatter so that `{param}: {ty}` is formatted as `{ty}` when
`{param}` is empty.
Fixes#671
* fix(scopes): Support inner scope
The purpose and usage of inner is still unclear, unfortunately, so this is an interim fix at best.
Fixes https://github.com/documentationjs/documentation/issues/652
* Improve comment typedef while we're at it
* feat(core): Switch to Promises everywhere. Adopt Node v4 ES6
Big changes:
* Uses template strings where appropriate
* Config and argument parsing is unified and there is no such thing
as formatterOptions anymore. All user-passed options go through
mergeConfig.
* The node API surface changed (again): `buildSync` is removed,
building operations return Promises.
* Now using Flow for internal type annotations.
More changes:
* Remove buildSync command
* feat(inference): Partially implement object shorthand support
* Refs #649
* Use Flow annotations to enforce types
* Keep flow but switch to comment syntax
* Clarify types
* More flow improvements
* Turn server into class
* LinkerStack becomes class too
* Fix comment description type
* Run flow on lint
* Many more flow fixes
* More intense flow refactoring
* Simplify inference steps
* Update inference tests, flow errors down to 1
* Continue refining types
* Fix more flow issues
* Use 'use strict' everywhere
* Make 'ast' property configurable
* Fix many tests
* Fix more tests
* Fix more tests
* Fix augments
* Test Markdown meta support
* Improve test coverage
* Switch back from for of to for for speed
Clicking on toc items generated from the documentation.yaml file didnt work. The target id was not properly slugged. Always slug your target. Very important.
Adds a new option, `--no-markdown-toc`, to turn off Table of Contents generation. Table of contents are now generated by default with markdown output, including through the `readme` command.
Fixes https://github.com/documentationjs/documentation/issues/220
