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

How do you make @link link to the type you want? #1297

Closed
StoneT2000 opened this issue May 7, 2020 · 1 comment
Closed

How do you make @link link to the type you want? #1297

StoneT2000 opened this issue May 7, 2020 · 1 comment
Labels
question Question about functionality

Comments

@StoneT2000
Copy link

I have a file with an exported alias called Tournament and an exported class called Tournament in another file.

In another file I then do ... see {@link Tournament} but it takes me to the alias called Tournament and not the class i wanted it to link to. Is there a way to resolve this and force the link to link to the right thing/

@Gerrit0 Gerrit0 added docs question Question about functionality labels May 15, 2020
@Gerrit0
Copy link
Collaborator

Gerrit0 commented May 15, 2020

I just created https://typedoc.org/guides/doccomments/ to document TypeDoc's link resolution process.

You can probably fix the link by using "file-name-with-quotes".Tournament as your link target.

If you are using --mode file, there is currently no way to disambiguate the links. Once we adopt TSDoc, you will be able to use :type to specify the type alias. See #1266, there's quite a bit of work to do before we get there unfortunately.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Question about functionality
Projects
None yet
Development

No branches or pull requests

2 participants