typescript - 如何使用 Typedoc 链接到另一个模块

Question

在 Typedoc 中，您可以使用以下方法链接到另一个类:

[[ClassName]]

{@link ClassName}

该类甚至可以属于另一个模块。

但是我不知道如何链接到

另一个模块

从另一个模块导出的函数

所以假设你有 2 d.ts文件:
Foo.d.ts

/**
 * I want to link to:
 * the [[Bar]] module //does not work
 * the {@link Bar} module //does not work
 * the [[Bar.foobar]] function //does not work
 * the {@link Bar.foobar]] function //does not work
 */
export class Foo{}

和 bar.d.ts

export function foobar(): string;

这样做的正确语法是什么？还是 Typedoc 不支持？

Answer 1

看起来像是 Typedoc 的一个缺点。
创建了 pull request来解决这个问题。

如果此拉取请求被接受，您应该能够使用 {@link "modulename"} 链接到您只有定义文件的模块。 (是的，需要引号)。