What markup should we use to tag that something is a method in typedoc. For example I have the following ment:

  /**
   * 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.
   */

How do I tell typedoc that addValidationContext is a method on the class?

What markup should we use to tag that something is a method in typedoc. For example I have the following ment:

  /**
   * 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.
   */

How do I tell typedoc that addValidationContext is a method on the class?

• javascript
• typescript
• jsdoc
• typedoc

2 Answers 2

TypeDoc has two methods for setting links. For methods and properties, you should be able to write [[ClassName.methodName]] or {@link ClassName.methodName} and have that converted to a link.

If you look at the doc ment for the Renderer class you can see an example which is rendered in the api documentation site.

You may use JSDoc {@link} or @see instructions.