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 with types and interfaces #2087

Closed
deviant310 opened this issue Oct 28, 2022 · 4 comments
Closed

@inheritDoc doesn't work with types and interfaces #2087

deviant310 opened this issue Oct 28, 2022 · 4 comments
Labels
bug Functionality does not match expectation

Comments

@deviant310
Copy link

Search terms

@inheritdoc, type, interface

Expected Behavior

/src/index.ts

/** Foo type comment */
export type Foo = () => number;

export class Bar {
  /**
   * {@inheritDoc Foo:type}
   */
  x = 1;
}

Expect that property x of Bar class will have the comment from Foo type

Actual Behavior

Got the message:

warning Bar.x tried to copy a comment from Foo with @inheritDoc, but the source has no associated comment.

and as a result
image

Steps to reproduce the bug

Run typedoc as usual via cli:

typedoc ./src/index.ts --out ./docs

Environment

  • Typedoc version: 0.23.18
  • TypeScript version: 4.8.4
  • Node.js version: 18.0.0
  • OS: MacOS
@deviant310 deviant310 added the bug Functionality does not match expectation label Oct 28, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Oct 29, 2022

sigh I missed another function type edge case. Shouldn't be too bad to fix. Will get it this weekend.

@deviant310
Copy link
Author

I see you've made some fixes, that's great! But it seems your updates doesn't come up with 0.23.19 version=((
Attached some screens
image
image

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Nov 3, 2022

I didn't make a release Friday, thought I was going to get #2084 as well Saturday, turned out to be way more complicated than expected at first... 0.23.20 is being published now

@deviant310
Copy link
Author

Got it now, thanks!

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
None yet
Development

No branches or pull requests

2 participants