Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

inheritdoc doesn't work for getter methods #1927

Closed
voldikss opened this issue May 6, 2022 · 0 comments
Closed

inheritdoc doesn't work for getter methods #1927

voldikss opened this issue May 6, 2022 · 0 comments
Labels
bug Functionality does not match expectation
Milestone

Comments

@voldikss
Copy link

voldikss commented May 6, 2022

Search terms

getter, inheritdoc

Expected Behavior

@inheritdoc for getter methods works

Actual Behavior

@inheritdoc for getter methods doesn't works, there is only an inheritdoc tag shown at the area.

Steps to reproduce the bug

With the following files,

// src/main.ts
export abstract class Base {
  /**
   * Some descriptions
   */
  abstract get type(): string
}

export class Derived extends Base {
  /**
   * @inheritdoc
   */
  public get type() {
    return ''
  }
}
// tsconfig.json
{
  "compilerOptions": {
    "target": "ES6"
  },
  "include": ["*.ts"]
}
// package.json
{
  "name": "typedoc-test",
  "version": "1.0.0",
  "main": "index.js",
  "license": "MIT",
  "devDependencies": {
    "typedoc": "^0.22.15",
    "typedoc-plugin-missing-exports": "^0.22.6"
  }
}

Run

yarn
yarn typedoc ./src/main.ts --out doc

Environment

  • Typedoc version: 0.22.15
  • TypeScript version: Version 4.5.4
  • Node.js version: v17.4.0
  • OS: Linux
@voldikss voldikss added the bug Functionality does not match expectation label May 6, 2022
@Gerrit0 Gerrit0 added this to To do in TSDoc - v0.23 via automation May 15, 2022
@Gerrit0 Gerrit0 added this to the v0.23 milestone May 15, 2022
@Gerrit0 Gerrit0 moved this from To do to Done in TSDoc - v0.23 May 15, 2022
@Gerrit0 Gerrit0 mentioned this issue May 30, 2022
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
No open projects
Development

No branches or pull requests

2 participants