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 resolution questions and possible bug (tsdoc reference resolutions) #342

Open
bradennapier opened this issue Jan 30, 2023 · 0 comments

Comments

@bradennapier
Copy link

bradennapier commented Jan 30, 2023

So this is actually TypeDoc that is producing the issue, but as it says they say they are using the standard set for resolving links from tsdoc itself (and because they haven't responded to the issue itself), I figured I'd post it here in case it is a tsdoc issue!

If it is an issue and it would save significant time to submit a PR I will if it actually is reviewed but with typedoc not responding I didn't want to waste my time for something that might be ignored :-)

If you guys could please review the detailed issue TypeStrong/typedoc#2141 I would appreciate it. I confirmed its an issue that isnt vscode or typescript compiler itself as a typescript team member indicated it is a bug in either tsdoc or typedoc and not either of those (they validate as expected by the typescript team member)

import (type?) * as enums from '../enums'; // doesnt work if you import type or import direct

/** {@link enums.MyEnum} or {@link enums.MyEnum MyEnum} does not resolve on docs but does on vscode */

/** {@link MyEnum} does not resolve on vscode (it uses global reference lookup in docs so it resolves in docs) */
  • so you have to choose if you want links to work in docs OR when using the code in IDE :(
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