Improve this page

ae-extra-release-tag

“The doc comment should not contain more than one release tag.”

Remarks

These TSDoc modifiers are called “release tags”:

  • @public
  • @beta
  • @alpha
  • @internal

A documentation comment should contain at most one release tag.

Example:

/**
 * @public @public
 */
export function f1(): void { }

// Warning: The doc comment should not contain more than one release tag.

In the example above, the @public release tag appears twice, so the error is reported.

How to fix

Remove the extra release tags.

See also