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.
* Fix membership infering for methods
Improve inferMembership to allow to use next code:
```js
/**
* @memberof BigFeature
*/
class MyClass {
method() {}
}
```
Before this improvement, we have `method` inside
`global.MyClass` instead of `global.BigFeature.MyClass`
* Add tests fir membership infering for methods
- Previously, headers were displayed using `p` and `strong` tags. This is semantically incorrect, and would cause subheadings to display larger than headings for nested sections on platforms such as Github.
- “Parameters”, “Properties”, and “Examples” now render as headings with a dynamic level greater than the heading they are nested under.
BREAKING CHANGE: changes Markdown output
* fix: adding vue support broke tests that are not file based
fix#1057
* Got the tests and code working for supporting non-file documenting
* Added fresh snapshot
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
* Use reference links in Markdown.
Fixes https://github.com/documentationjs/documentation/issues/948.
This approach might be problematic when inserting markdown under a readme heading if the readme already has link references with conflicting ID’s.
* Reference links edits:
- fix broken normalize() utility in test suite so that it produces
output that doesn't choke referenceLinks.
- add DocumentationConfig option `--noReferenceLinks` which will be
**internal only**, and turns off reference links for `readme` mode
- rebuilds test output with these changes
unrelated but minor
- includes .prettierrc and updates calls to prettier to use that instead
of CLI options
* chore: update test snapshots
* Update readme snap
* github link to typedef points to comment lines
* adding test for typedef github links
* adding comment.loc for flow check
* reverting to original formatting
* use afterEach to restore mock even if tests fail
* fixing line numbers in expected value
* 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.
Per usejsdoc.org, this tag goes either in a comment attached to a
function that has declared that function to be a class, or in a comment
on an ES6 class constructor.
