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

The buildLink function in helpers/comment.ts is not context-dependent anymore #274

Closed
danieleds opened this issue Dec 15, 2021 · 0 comments

Comments

@danieleds
Copy link
Contributor

danieleds commented Dec 15, 2021

In typedoc, links are resolved in a context-dependent way, see https://typedoc.org/guides/link-resolution/.

This worked correctly in a previous version of typedoc-plugin-markdown, but in the latest version it is broken.

This is a problem if for example you want to do this:

export interface A extends Base { }
export interface B extends Base { }

interface Base {
  /**
   * Use {@link method2}
   */
  method1()

  method2()
}

because this plugin will generate one link for A.method1 and one link for B.method1, but they'll both link to A.method2.

tgreyuk added a commit that referenced this issue Dec 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant