Skip to content

Commit b7680c0

Browse files
authored
Clarify the behavior of @inheritdoc
Additional info copied from https://api-extractor.com/pages/tsdoc/tag_inheritdoc/
1 parent b2bdf5c commit b7680c0

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

tsdoc/src/details/StandardTags.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,18 @@ export class StandardTags {
124124
* to the other item, which may be an unrelated class, or even an import from a
125125
* separate NPM package.
126126
*
127+
* What gets copied
128+
*
129+
* The @inheritDoc tag does not copy the entire comment body. Only the following
130+
* components are copied:
131+
* - summary section
132+
* - @remarks block
133+
* - @params blocks
134+
* - @typeParam blocks
135+
* - @returns block
136+
* Other tags such as @defaultValue or @example are not copied, and need to be
137+
* explicitly included after the @inheritDoc tag.
138+
*
127139
* TODO: The notation for API item references is still being standardized. See this issue:
128140
* https://github.com/microsoft/tsdoc/issues/9
129141
*/

0 commit comments

Comments
 (0)