File tree Expand file tree Collapse file tree 1 file changed +12
-0
lines changed Expand file tree Collapse file tree 1 file changed +12
-0
lines changed Original file line number Diff line number Diff line change @@ -124,6 +124,18 @@ export class StandardTags {
124
124
* to the other item, which may be an unrelated class, or even an import from a
125
125
* separate NPM package.
126
126
*
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
+ *
127
139
* TODO: The notation for API item references is still being standardized. See this issue:
128
140
* https://github.com/microsoft/tsdoc/issues/9
129
141
*/
You can’t perform that action at this time.
0 commit comments