Clarify the behavior of @inheritDoc
Additional info copied from https://api-extractor.com/pages/tsdoc/tag_inheritdoc/
This commit is contained in:
Родитель
b2bdf5ca8a
Коммит
b7680c0ed4
|
@ -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
|
||||
*/
|
||||
|
|
Загрузка…
Ссылка в новой задаче