We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
externalSymbolLinkMappings to TypeScript resolved link
Given the following, TypeDoc should produce a link to example.com, and not produce any warnings.
import * as random from "@pulumi/random"; /** * Blah blah {@link random.RandomPassword}. */ export function someFunction() {}
Config:
/** @type {Partial<import('typedoc').TypeDocOptions>} */ const config = { ..., externalSymbolLinkMappings: { "@pulumi/random": { "*": "https://example.com" } }, }; export default config;
TypeDoc produces a warning:
[warning] Failed to resolve link to "random.RandomPassword" in comment for someFunction
Reported by @stazz in #2700
The text was updated successfully, but these errors were encountered:
1cefc01
I'm going to wait until Sunday to publish 0.26.9 as I just made a release earlier today, just in case more issues crop up.
"typedoc": "github:TypeStrong/typedoc#1cefc011948fa06f798a0763ba5cc9d32f6ac04e"
can be used to install TypeDoc with this patch applied in the meantime
Sorry, something went wrong.
No branches or pull requests
Search terms
externalSymbolLinkMappings to TypeScript resolved link
Expected Behavior
Given the following, TypeDoc should produce a link to example.com, and not produce any warnings.
Config:
Actual Behavior
TypeDoc produces a warning:
Environment
Reported by @stazz in #2700
The text was updated successfully, but these errors were encountered: