ae-cyclic-inherit-doc
"The @inheritDoc
tag for ___ refers to its own declaration".
Remarks
The @inheritDoc
tag saves typing by copying documentation content from another declaration. The other declaration
is specified using a TSDoc declaration reference. But if the other reference refers back to the original declaration,
then an ae-cyclic-inherit-doc
error is reported.
The self-reference can be simple:
/**
* {@inheritDoc f1}
* @public
*/
export function f1(): void {}
// Warning: The "@inheritDoc" tag for "f1" refers to its own declaration.
Or it can be indirect:
/**
* {@inheritDoc f2}
* @public
*/
export function f1(): void {}
/**
* {@inheritDoc f3}
* @public
*/
export function f2(): void {}
/**
* {@inheritDoc f1}
* @public
*/
export function f3(): void {}
// Warning: The "@inheritDoc" tag for "f1" refers to its own declaration.
How to fix
Remove or change one of the @inheritDoc
tags to eliminate the cycle.