typedoc-plugin-no-inherit
typedoc-plugin-no-inherit copied to clipboard
jonchardy
Exclude inherited members from a Typedoc class using @noInheritDoc annotation
Bumps [tmpl](https://github.com/daaku/nodejs-tmpl) from 1.0.4 to 1.0.5. Commits See full diff in compare view [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter...
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot] avatar"){kind=avatar}
``` "devDependencies": { "@types/node": "^16.10.5", "@typescript-eslint/eslint-plugin": "^5.13.0", "@typescript-eslint/parser": "^5.13.0", "bluebird": "^3.7.2", "cmake-js": "^6.2.1", "eslint": "^7.32.0", "mocha": "^9.1.1", "node-addon-api": "^4.3.0", "nyc": "^15.1.0", "typedoc": "^0.22.13", "typedoc-github-wiki-theme": "^1.0.0", "typedoc-plugin-markdown": "^3.11.14", "typedoc-plugin-no-inherit": "^1.3.1", "typescript":...
Use case: I've a class that extends Node.js `EventEmitter` but I don't want to show all methods / properties from that class on the documentation of my own class, I...
Thanks for this project! One thing that is unfortunate is that the `@noInheritDoc` tags are kept in the source code and produced in the dist output (tsc with `"removeComments": false`)...
```ts import { EventEmitter } from 'events'; /** * Foo class. * @noInheritDoc */ export class Foo extends EventEmitter { // ... } ``` `Foo` class generated docs don't show...
Bumps [json5](https://github.com/json5/json5) from 2.2.1 to 2.2.3. Release notes Sourced from json5's releases. v2.2.3 Fix: [email protected] is now the 'latest' release according to npm instead of v1.0.2. (#299) v2.2.2 Fix: Properties...
Adds a rudimentary boolean `alwaysOmitInheritance` option to treat everything as having a `@noInheritDoc` tag. I'm not particularly familiar with TypeDoc and couldn't figure out how to get the option parsed...
