File tree Expand file tree Collapse file tree 1 file changed +7
-7
lines changed Expand file tree Collapse file tree 1 file changed +7
-7
lines changed Original file line number Diff line number Diff line change @@ -126,15 +126,15 @@ export class StandardTags {
126
126
*
127
127
* What gets copied
128
128
*
129
- * The @inheritDoc tag does not copy the entire comment body. Only the following
129
+ * The ` @inheritDoc` tag does not copy the entire comment body. Only the following
130
130
* components are copied:
131
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.
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
138
*
139
139
* TODO: The notation for API item references is still being standardized. See this issue:
140
140
* https://github.com/microsoft/tsdoc/issues/9
You can’t perform that action at this time.
0 commit comments