Как сделать ссылку на другой модуль, используя Typedoc - PullRequest
0 голосов
/ 17 октября 2019

В 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?

1 Ответ

0 голосов
/ 18 октября 2019

Похоже на недостаток в Typedoc. Создан запрос на получение для решения этой проблемы.

Если этот запрос на получение будет принят, вы сможете ссылаться на модуль, для которого у вас есть только файл определения, используя {@link "modulename"} (да, цитаты нужны).

...