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
Third-Party symbol not resolved in @link #2030
Comments
No, you didn't miss anything. Since
Letting plugins add resolvers for external /**
* See {@link solclientjs!Session} for more information.
*/
export class MessageClient {} I like the idea of |
Thank you @Gerrit0 for the detailed explanation and for marking this as an enhancement I would like to see in a future release:-) |
Half of #2030 complete! externalSymbolLinkMappings tomorrow.
These docs will be added to the website as well on release - but too late for that tonight, do you think this will meet your use case? https://github.com/TypeStrong/typedoc/blob/master/internal-docs/third-party-symbols.md#third-party-symbols |
@Gerrit0 Great, this is precisely what we were looking for and will cover our use case. Thank you very much! |
Search terms
link; link to third-party symbol; third-party symbol; will break in v0.24
Question
We generate API documentation for a library that heavily depends on a third-party library. In many comments, we refer to types of that third-party library using the link tag, e.g.,
{@link Session}
.When generating the documentation, for every link to the third-party library, we get an error like
Failed to resolve {@link Session} in ... with declaration references. This link will break in v0.24.
That makes sense since TypeDoc has no idea where to find the respective documentation site. We learned that we could write a custom TypeDoc plugin similar to the MDN link plugin for providing a mapping for our third-party symbols. But, it turned out that this only works for symbols referenced in code but not for symbols referenced in links via the@link
tag.Below an example. The
MessageClient
class references the third-party symbolSession
both by link and in the constructor.Did we miss something?
Also, having to write a custom TypeDoc plugin for solely providing associations of third-party symbols to their documentation site seems very cumbersome. Isn't there a way to configure the mappings directly in
tsconfig.json
undertypedocOptions
? That would be so straightforward, sort of like this. What do you think about it?The text was updated successfully, but these errors were encountered: