Correct documentation for jsDocCompatibility

TypeStrong · Nov 27, 2024 · 110b081 · 110b081
1 parent 51dcb74
commit 110b081
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -677,7 +677,7 @@ title: Changelog
 -   Added `--disableGit` option to prevent TypeDoc from using Git to try to determine if sources can be linked, #2326.
 -   Added support for tags `@showGroups`, `@hideGroups`, `@showCategories`, `@hideCategories` to configure the navigation pane on a
     per-reflection basis, #2329.
--   With `--jsDocCompatibility.defaultTags` set, `@defaultValue` is now implicitly a code block if the text contains no code, #2370.
+-   With `--jsDocCompatibility.defaultTag` set, `@defaultValue` is now implicitly a code block if the text contains no code, #2370.
 
 ### Bug Fixes
 

diff --git a/site/options/comments.md b/site/options/comments.md
@@ -42,16 +42,16 @@ CLI:
 
 ```bash
 $ typedoc --jsDocCompatibility false
-$ typedoc --jsDocCompatibility.defaultTags false
+$ typedoc --jsDocCompatibility.defaultTag false
 ```
 
 typedoc.json (defaults):
 
 ```json
 {
     "jsDocCompatibility": {
-        "exampleTags": true,
-        "defaultTags": true,
+        "exampleTag": true,
+        "defaultTag": true,
         "inheritDocTag": true,
         "ignoreUnescapedBraces": true
     }