Skip to content

Documenting getters and setters #64

@IjzerenHein

Description

@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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions