documentationjs / documentationjs/documentation
Missing information for ES6 getters/setters
- Dominant language
- JavaScript
- Stars
- 5.8k
- Forks
- 481
- PR merge metrics
- No merged PRs in 30d
Description
* What version of documentation.js are you using?:
5.3.1
* How are you running documentation.js (on the CLI, Node.js API, Grunt, other?):
CLI
I'm trying to document ES6 getters/setters. I couldn't find any documentation for documentationjs, but for jsdoc it seems that [`@type` is the preferred syntax](https://stackoverflow.com/a/22276207/399105). For example:
Input:
/**
* Game version.
* @type {string}
*/
get gameVersion() {
return this._getPropertyIfDefined('gameVersion');
}
Output:
### gameVersion
Game version.
I would have expected there to be some mention:
1. That the property is of type `string`
2. That this property is read-only (i.e. there's a getter but no setter)
Should I be using a different syntax?
Thanks!
Contributor guide
Assessment
This issue has not been assessed yet.