TypeDoc @link attribute

This issue has been tracked since 2023-03-12.

Search terms

link

Question

I had a lot of [[links]] in my comments, and since 0.24.0 is dropping the support to that, I tried migrating to {@link value} syntax without success. This issue happens in 0.23.x and 0.24.0-beta.3

Like this:

https://github.com/matteobruni/tsparticles/blob/075bfbcead80a456312f893152be6acf625a81c3/engine/src/Core/Loader.ts#L31

/**
 * Main class for creating the {@link Container} objects
 * @category Core
 */

The Container linked is a class imported and existing in the same folder

https://github.com/matteobruni/tsparticles/blob/075bfbcead80a456312f893152be6acf625a81c3/engine/src/Core/Loader.ts#L2
https://github.com/matteobruni/tsparticles/blob/v2/engine/src/Core/Container.ts

But when I build the docs I got errors like this:

[warning] Failed to resolve link to "Container" in comment for tsParticles Engine.Core/Loader.Loader.
[warning] Failed to resolve link to "Container" in comment for tsParticles Engine.Core/Loader.Loader.load.
[warning] Failed to resolve link to "Container" in comment for tsParticles Engine.Core/Loader.Loader.load.options.
[warning] Failed to resolve link to "Container" in comment for tsParticles Engine.Core/Loader.Loader.loadJSON.
[warning] Failed to resolve link to "Container" in comment for tsParticles Engine.Core/Loader.Loader.set.
[warning] Failed to resolve link to "Container" in comment for tsParticles Engine.Core/Loader.Loader.set.options.
[warning] Failed to resolve link to "Container" in comment for tsParticles Engine.Core/Loader.Loader.setJSON.

But I don't understand what's wrong with my link.

Other links tried without success:

{@link Container:class}
{@link Container:type}

More Details About Repo
Owner Name TypeStrong
Repo Name typedoc
Full Name TypeStrong/typedoc
Language TypeScript
Created Date 2014-05-24
Updated Date 2023-03-19
Star Count 6487
Watcher Count 68
Fork Count 639
Issue Count 48

YOU MAY BE INTERESTED

Issue Title Created Date Updated Date