Пометить / создать ссылку на метод в typedoc?

Question

Какую разметку мы должны использовать, чтобы пометить, что что-то является методом в typedoc. Например, у меня есть следующий комментарий:

  /**
   * The index for all of the ValidationContext instances.
   * Not meant to be accessed directly.  Only decorators should
   * be modifying the state of the cache by using the addValidationContext() method.
   */

Как мне сказать typedoc, что addValidationContext - это метод в классе?

Answer 1

В TypeDoc есть два метода установки ссылок. Для методов и свойств вы должны написать [[ClassName.methodName]] или {@link ClassName.methodName} и преобразовать их в ссылку.

Если вы посмотрите комментарий к документу для класса Renderer, вы можете увидеть пример, представленный на сайте документации api .

Answer 2

Вы можете использовать JSDoc {@ link} или @ см. инструкции.