Repository navigation
Documenting getters and setters #64
Description
Hi! First of all, great library, love the output it generates :)
Hey, I've got classes with getters and setters, like this:
export default class Label2 extends Surface {
constructor(options) {
super(options);
this.text = (options && options.text) ? options.text : '';
}
/**
* Text that is displayed in the label.
*
* @type {String}
*/
get text() {
return this._text;
}
set text(text) {
text = text || '';
if (this._text !== text) {
this._text = text;
// do stuff here
}
}
}It generates this output:
It fails to document the getter/setter property, because this.text = (options && options.text) ? options.text : ''; exists in the constructor. When clicking on 'source' it points to the constructor code:
Am I doing it right? How can I fix this?
Cheers
Activity
h13i32maru commentedon Sep 3, 2015
@IjzerenHein Hi! Thanks for this issue!
This is ESDoc bug 😓 I will try to fix it. Please wait a little.
IjzerenHein commentedon Sep 3, 2015
No worries, let me know if I need to help with testing anything.
Cheers dude, and thanks for this awesome doc generator :)
fix: exclude member, when same name getter/setter/method are exist.
h13i32maru commentedon Sep 6, 2015
I fixed it. Please try to use HEAD.
https://github.com/esdoc/esdoc/blob/master/CONTRIBUTING.md#install-from-head
IjzerenHein commentedon Sep 6, 2015
Awesome, will try =)
IjzerenHein commentedon Sep 6, 2015
Awesome, works like a charm now :)))
Thanks!!