Inherited Documentation

[Alon-L]

Search Terms

Inherited Documentation, Abstract Documentation, Class Extend Documentation

Problem

There currently doesn't seem to be a way to inherit documentation for properties or methods implemented from abstract classes (might also be the case when extending classes, haven't checked).

Suggested Solution

Documentation for a property or method you implement should be inherited from the abstract class you implemented unless an override is present.

e.x.

abstract class A {
  /**
   * This is the description for a.
   */
  abstract a: string;

  /**
   * This is the description for print.
   * @returns {void}
   */
  abstract print(): void;
}

class B implements A {
  // The description for 'a' will be inherited from A - 'This is the description for a.'
  public a: string = 'b';

  // The description and additional attributes for 'print' will be inherited from A.
  public print(): void {
    console.log(this.a);
  }
}

class C implements A {
  // The description for 'a' will be overriden
  /**
   * This is a new description for a.
   */
  public a: string = 'b';

  // The description for 'print' will be overriden
  /**
   * This is a new description for print.
   * @returns {void} new return description
   */
  public print(): void {
    console.log(this.a);
  }
}

[Alon-L]

Just saw issue #787
Thank you for implementing this!