Skip to content

Commit 95b6c05

Browse files
authored
Added tick around @-tags
1 parent b7680c0 commit 95b6c05

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

tsdoc/src/details/StandardTags.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -126,15 +126,15 @@ export class StandardTags {
126126
*
127127
* What gets copied
128128
*
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
130130
* components are copied:
131131
* - 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.
138138
*
139139
* TODO: The notation for API item references is still being standardized. See this issue:
140140
* https://github.com/microsoft/tsdoc/issues/9

0 commit comments

Comments
 (0)