From 110b081d1c3c8ae6f90acc0a7b138dbea1bda7ae Mon Sep 17 00:00:00 2001
From: Gerrit Birkeland <gerrit@gerritbirkeland.com>
Date: Wed, 27 Nov 2024 15:55:16 -0700
Subject: [PATCH] Correct documentation for jsDocCompatibility

---
 CHANGELOG.md             | 2 +-
 site/options/comments.md | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 5ea50777b..fca3b7629 100644
--- 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
index 43087604b..193b73ca4 100644
--- a/site/options/comments.md
+++ b/site/options/comments.md
@@ -42,7 +42,7 @@ CLI:
 
 ```bash
 $ typedoc --jsDocCompatibility false
-$ typedoc --jsDocCompatibility.defaultTags false
+$ typedoc --jsDocCompatibility.defaultTag false
 ```
 
 typedoc.json (defaults):
@@ -50,8 +50,8 @@ typedoc.json (defaults):
 ```json
 {
     "jsDocCompatibility": {
-        "exampleTags": true,
-        "defaultTags": true,
+        "exampleTag": true,
+        "defaultTag": true,
         "inheritDocTag": true,
         "ignoreUnescapedBraces": true
     }