You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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. 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:
That the property is of type string
That this property is read-only (i.e. there's a getter but no setter)
Should I be using a different syntax?
Thanks!
The text was updated successfully, but these errors were encountered:
It seems like @type isn't supported and the closest thing I could find in the docs is to basically duplicate the documentation for the getter and the setter, but with a different signature. That's a bit verbose and error-prone.
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. For example:Input:
Output:
I would have expected there to be some mention:
string
Should I be using a different syntax?
Thanks!
The text was updated successfully, but these errors were encountered: