Skip to content

Commit 110b081

Browse files
committed
Correct documentation for jsDocCompatibility
1 parent 51dcb74 commit 110b081

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -677,7 +677,7 @@ title: Changelog
677677
- Added `--disableGit` option to prevent TypeDoc from using Git to try to determine if sources can be linked, #2326.
678678
- Added support for tags `@showGroups`, `@hideGroups`, `@showCategories`, `@hideCategories` to configure the navigation pane on a
679679
per-reflection basis, #2329.
680-
- With `--jsDocCompatibility.defaultTags` set, `@defaultValue` is now implicitly a code block if the text contains no code, #2370.
680+
- With `--jsDocCompatibility.defaultTag` set, `@defaultValue` is now implicitly a code block if the text contains no code, #2370.
681681

682682
### Bug Fixes
683683

site/options/comments.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,16 @@ CLI:
4242

4343
```bash
4444
$ typedoc --jsDocCompatibility false
45-
$ typedoc --jsDocCompatibility.defaultTags false
45+
$ typedoc --jsDocCompatibility.defaultTag false
4646
```
4747

4848
typedoc.json (defaults):
4949

5050
```json
5151
{
5252
"jsDocCompatibility": {
53-
"exampleTags": true,
54-
"defaultTags": true,
53+
"exampleTag": true,
54+
"defaultTag": true,
5555
"inheritDocTag": true,
5656
"ignoreUnescapedBraces": true
5757
}

0 commit comments

Comments
 (0)