BREAKING CHANGE: This moves documentation.js to Babel 7. From now on,
documentation.js will only support Babel 7: please stick to older
releases if you need to support Babel 6. Additionally, this work
temporarily disables support for following dynamic imports.
Support decorators is an unspecified part of JSDoc: we're just going forward and implementing a new
syntax here because it's unlikely that JSDoc will move fast enough.
Fixes#1016
Previously we did not properly infer params on methods that were located on class properties. This
changes things so that we do. It carefully tries to avoid messing up the existing support of class
type annotations, which are similar to class properties at the AST level, but do not have an
associated node, only a type alias.
Fixes#1043
* Add shared_options to readme command.
This makes --shallow and --format work again.
* Update yarn.lock based on package.json.
* Move readme example to where it works,
remove superfluous usage string.
yargs@>=7 throws exceptions on incorrectly structured builder objects.
* Update expected readme test fixture.
* Update bin-readme snapshot.
* s/_.assign/Object.assign/g thanks to node@>=4.
* Update yarn.lock based on package.json (lint-staged@6)
* Override flow error message.
Fix default_theme to render all parameter properties.
- Split the parameter property template portion into its own partial.
- Have the new partial recursively call itself if there are sub-properties.
The previous support for @name tags suppressing inference from
surrounding code was ad-hoc and incomplete. This commit makes a @name
tag (or a tag acting as a @kind/@name shorthand combo, like @function)
detach the `ast` field from the comment context, so that the surrounding
code will be universally ignored per the JSDoc spec.
BREAKING CHANGE: I'd like to still support C++ and other languages in the future! But I'm much
happier doing so by separating the extraction & input phases to the degree that documentation.js can
read the output of another module that extracts JSDoc comments from C++ code, rather than having CPP
support in it.
Fixes#850. Fixes#731. Fixes#702. Fixes#132.
* build: Use Flow syntax without comments.
We're switching to Flow annotations - not Flow comments. This
gives documentation.js the ability to self-document without
JSDoc types and improves our compatibility with tools like
prettier.
Fixes#729. Fixes#709