-
-
Notifications
You must be signed in to change notification settings - Fork 745
Closed as not planned
Closed as not planned
Copy link
Labels
externalProblem lies outside of TypeDocProblem lies outside of TypeDoc
Description
Search terms
throws, link
Expected Behavior
Links that occur right after @throws
should be rendered as links (e.g. @throws {@link AnError}
)
Actual Behavior
In some cases TypeDoc renders it as plain text instead of a link and prints the following warning:
[warning] Failed to resolve link to "(...)" in comment for (...)
Steps to reproduce the bug
It looks like if the following conditions are met:
entryPointStrategy
is set toexpand
,- any
*.ts
file is present in a directory above the target file (Example.ts
in this case - see the repo link below), but inside the directory specified inentryPoints
then the link that occurs right after @throws
is rendered as plain text instead of a link (for imported classes):
/**
* {@link RendersAsLink}
* @throws {@link RendersAsPlainText} - {@link RendersAsLink}
*/
Reproduction: https://github.com/wpazderski/tmp-typedoc-bug
Environment
- Typedoc version: 0.28.9
- TypeScript version: 5.9.2
- Node.js version: 24.1.0
- OS: MacOS
Metadata
Metadata
Assignees
Labels
externalProblem lies outside of TypeDocProblem lies outside of TypeDoc