typedoc-plugin-no-inherit

Typedoc plugin to exclude inherited members from a Typedoc class/interface

MIT 20 个版本

typedoc-plugin

主页

仓库

提交 Issue

安装

npm install typedoc-plugin-no-inherit

yarn add typedoc-plugin-no-inherit

pnpm add typedoc-plugin-no-inherit

bun add typedoc-plugin-no-inherit

README

typedoc-plugin-no-inherit

A plugin for Typedoc to exclude inherited members from a Typedoc class using @noInheritDoc annotation.

Installation

npm install typedoc-plugin-no-inherit --save-dev

Usage

Add @noInheritDoc tags in a class or interface's docstring to prevent it from inheriting documentation from its parents.

class Animal {
  /**
   * Documentation for move() method.
   */
  public move(distanceInMeters: number = 0) {
    console.log(`Animal moved ${distanceInMeters}m.`);
  }
}

/**
 * Documentation for the Dog class.
 * @noInheritDoc
 */
class Dog extends Animal {
  /**
   * Documentation for bark() method.
   */
  public bark() {
    console.log("Woof! Woof!");
  }
}

Options

Option	Type	Default	Description
`inheritNone`	`boolean`	`false`	Whether to treat all declarations as having the '@noInheritDoc' tag.

版本列表

1.6.1 2025-04-18

1.6.0 2025-04-10

1.5.0 2025-01-02

1.4.0 2022-08-29

1.3.1 2021-10-19

1.3.0 2021-05-20

1.2.2 2021-03-05

1.2.0 2020-09-11

1.1.10 2019-08-28

1.1.9 2019-07-12

1.1.8 2019-05-14

1.1.7 2019-05-14

1.1.6 2019-02-13

1.1.5 2019-02-04

1.1.4 2019-02-01

1.1.3 2019-02-01

1.1.2 2019-01-10

1.1.1 2019-01-04

1.1.0 2018-12-27

1.0.2 2018-11-08