Skip to content

Including documentation for methods inherited via extends #256

@djipco

Description

@djipco

I have a class that extends another one. Is it possible for the child class to include documentation for inherited methods? I'm only getting documentation for the actual methods in the class and not the inherited ones.

I can see that my @extends keyword is picked up because it shows up in the generated docs. This is basically my setup:

/**
 * Vehicle Class
 */
class Vehicle {
  start() {
    // Vroom!
  }
}
import {Vehicle} from "./Vehicle.js";
/**
 * Tank Class
 * @extends Vehicle
 */
class Tank extends Vehicle {
  fire() {
    // fire!
  }
}

In the documentation for the Tank class, I see the fire() method but not the start() method. Is that normal?

Metadata

Metadata

Assignees

No one assigned

    Labels

    datatemplateRequires a change to a dmd partial/helper

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions