defaultValue is implicitly code only with JSDoc compat

TypeStrong · Aug 25, 2023 · 3d8ff29 · 3d8ff29
1 parent 028a141
commit 3d8ff29
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,7 @@
 -   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.
 
 ### Bug Fixes
 
@@ -39,6 +40,7 @@
 
 -   @camc314
 -   @cprussin
+-   @roggervalf
 -   @Th3S4mur41
 
 ## v0.24.8 (2023-06-04)

diff --git a/src/lib/converter/comments/parser.ts b/src/lib/converter/comments/parser.ts
@@ -216,8 +216,8 @@ function blockTag(
     if (tagName === "@example" && config.jsDocCompatibility.exampleTag) {
         content = exampleBlockContent(comment, lexer, config, warning);
     } else if (
-        (tagName === "@default" && config.jsDocCompatibility.defaultTag) ||
-        tagName === "@defaultValue"
+        ["@default", "@defaultValue"].includes(tagName) &&
+        config.jsDocCompatibility.defaultTag
     ) {
         content = defaultBlockContent(comment, lexer, config, warning);
     } else {