Documenting getters and setters #64

Closed
IjzerenHein opened this Issue Aug 30, 2015 · 5 comments

Comments

Projects
None yet
2 participants
@IjzerenHein

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:
image

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:

image

Am I doing it right? How can I fix this?

Cheers

@h13i32maru

This comment has been minimized.

Show comment
Hide comment
@h13i32maru

h13i32maru Sep 3, 2015

Member

@IjzerenHein Hi! Thanks for this issue!
This is ESDoc bug 😓 I will try to fix it. Please wait a little.

Member

h13i32maru commented Sep 3, 2015

@IjzerenHein Hi! Thanks for this issue!
This is ESDoc bug 😓 I will try to fix it. Please wait a little.

@IjzerenHein

This comment has been minimized.

Show comment
Hide comment
@IjzerenHein

IjzerenHein 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 :)

No worries, let me know if I need to help with testing anything.
Cheers dude, and thanks for this awesome doc generator :)

@h13i32maru

This comment has been minimized.

Show comment
Hide comment

@h13i32maru h13i32maru closed this Sep 6, 2015

@IjzerenHein

This comment has been minimized.

Show comment
Hide comment
@IjzerenHein

IjzerenHein Sep 6, 2015

Awesome, will try =)

Awesome, will try =)

@IjzerenHein

This comment has been minimized.

Show comment
Hide comment
@IjzerenHein

IjzerenHein Sep 6, 2015

Awesome, works like a charm now :)))
Thanks!!

Awesome, works like a charm now :)))
Thanks!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment