search

jonchardy / typedoc-plugin-no-inherit

Exclude inherited members from a Typedoc class using @noInheritDoc annotation
MIT License
20 stars 6 forks source link

seems to stop working with extra interface declaration #29

Open Zvicii opened 2 years ago

Zvicii commented 2 years ago 
"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": "^4.3.5",
    "typescript-eslint": "0.0.1-alpha.0"
  },

command:

npx typedoc

output:

Info: Loaded plugin typedoc-plugin-markdown
Info: Loaded plugin typedoc-github-wiki-theme
Info: Loaded plugin typedoc-plugin-no-inherit.
Info: Documentation generated at ./doc
jonchardy commented 2 years ago

My testing still has correct output. Do you have a small project where this can be reproduced?

Zvicii commented 2 years ago

It seems that if I add extra interface declaration, it would stop working.

import ev from 'events';
/**
 * Documentation for the Dog class.
 * @noInheritDoc
 */
export declare interface Test {
    on(event: 'event', listener: () => void): this;
}
/**
 * Documentation for the Dog class.
 * @noInheritDoc
 */
export class Test extends ev.EventEmitter {
    constructor() {
        super();
    }
}