ae-cyclic-inherit-doc
@inheritDoc
タグは、___それ自体の宣言を参照します。
注記
@inheritDoc
タグは別の宣言からドキュメントの内容をコピーしてタイピングを削減します。別の宣言は、TSDoc 宣言参照を使用して指定されます。ただし、別の参照が元の宣言を参照している場合、ae-cyclic-inherit-doc
エラーが報告されます。
自己参照は次のようになります。
/**
* {@inheritDoc f1}
* @public
*/
export function f1(): void {}
// Warning: The "@inheritDoc" tag for "f1" refers to its own declaration.
または、次のようになります。
/**
* {@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.
解決方法
サイクルを排除するには、1 つの @inheritDoc
タグを削除するか変更します。