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

@link within @param fails to resolve #2031

Closed
frank-weindel opened this issue Aug 11, 2022 · 1 comment
Closed

@link within @param fails to resolve #2031

frank-weindel opened this issue Aug 11, 2022 · 1 comment
Labels
bug Functionality does not match expectation

Comments

@frank-weindel
Copy link

frank-weindel commented Aug 11, 2022

Search terms

link param

Expected Behavior

Linking (via @link) to a method by name from an @param of another method in the same class should work and not cause an error.

Actual Behavior

This error is produced:

warning Failed to resolve {@link anotherMethod} in MyClass.aMethod.aParam with declaration references. This link will break in v0.24.

VSCode properly handles the link within the quick info UI

Steps to reproduce the bug

Repro PR:

class MyClass {

  /**
   * Documentation for aMethod()
   *
   * This is OK: {@link anotherMethod}
   *
   * @param aParam But this produces an error: {@link anotherMethod}
   */
  aMethod(aParam: number) {

  }

  /**
   * Documentation for anotherMethod()
   */
  anotherMethod() {

  }
}

Environment

  • Typedoc version: 0.23.10
  • TypeScript version: 4.7.3
  • Node.js version: v16.14.0
  • OS: macOS 12.2.1
@frank-weindel frank-weindel added the bug Functionality does not match expectation label Aug 11, 2022
frank-weindel added a commit to frank-weindel/typedoc-repros that referenced this issue Aug 11, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Aug 13, 2022

Thanks for the awesome bug report! Made fixing that really easy

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