ae-unresolved-inheritdoc-base
「{@inheritDoc} タグには TSDoc 宣言参照が必要です。署名の照合はまだサポートされていません」
解説
次のような宣言があるとします
export class Base {
/**
* Some documentation that we want to inherit
*/
public member(): void {}
}
export interface IChild {
/**
* Some documentation that we want to inherit
*/
value: string;
}
...ここで、次のようにドキュメントを継承します
export class Child extends Base implements IChild {
/** {@inheritDoc} */ // <-- not supported
public member(): void {}
/** {@inheritDoc} */ // <-- not supported
public value: string = 'example';
}
// Warning: The @inheritDoc tag needs a TSDoc declaration reference;
// signature matching is not supported yet
{@inheritDoc} タグが基底クラスまたはインターフェイスの対応するメンバーと一致すれば便利です。これは将来的に実装される可能性がありますが、現時点ではサポートされていません。代わりに、次のように明示的な宣言参照を指定する必要があります
export class Child extends Base implements IChild {
/** {@inheritDoc Base.member} */
public member(): void {}
/** {@inheritDoc IChild.value} */
public value: string = 'example';
}
修正方法
{@inheritDoc} タグに明示的な宣言参照を追加します。