typedoc-plugin-no-inherit
Typedoc plugin to exclude inherited members from a Typedoc class/interface
Last updated 10 months ago by jonchardy .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install typedoc-plugin-no-inherit 
SYNC missed versions from official npm registry.

typedoc-plugin-no-inherit

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

npm Build Status

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!');
  }
}

Current Tags

  • 1.1.10                                ...           latest (10 months ago)

12 Versions

  • 1.1.10                                ...           10 months ago
  • 1.1.9                                ...           a year ago
  • 1.1.8                                ...           a year ago
  • 1.1.7                                ...           a year ago
  • 1.1.6                                ...           a year ago
  • 1.1.5                                ...           a year ago
  • 1.1.4                                ...           a year ago
  • 1.1.3                                ...           a year ago
  • 1.1.2                                ...           2 years ago
  • 1.1.1                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.2                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 90
This Month 151
Last Day 1
Last Week 119
Last Month 497
Dependencies (0)
None
Dev Dependencies (7)

Copyright 2014 - 2017 © taobao.org |