Clarify the behavior of @inheritDoc

Additional info copied from https://api-extractor.com/pages/tsdoc/tag_inheritdoc/
This commit is contained in:
Arno Gourdol 2020-04-29 14:38:33 -07:00 коммит произвёл GitHub
Родитель b2bdf5ca8a
Коммит b7680c0ed4
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 12 добавлений и 0 удалений

Просмотреть файл

@ -124,6 +124,18 @@ export class StandardTags {
* to the other item, which may be an unrelated class, or even an import from a
* separate NPM package.
*
* What gets copied
*
* The @inheritDoc tag does not copy the entire comment body. Only the following
* components are copied:
* - summary section
* - @remarks block
* - @params blocks
* - @typeParam blocks
* - @returns block
* Other tags such as @defaultValue or @example are not copied, and need to be
* explicitly included after the @inheritDoc tag.
*
* TODO: The notation for API item references is still being standardized. See this issue:
* https://github.com/microsoft/tsdoc/issues/9
*/