fix(core): fix missing return comments for const functions

typedoc2md · Jul 24, 2024 · b95b7f4 · b95b7f4
1 parent 967c584
commit b95b7f4
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/.changeset/swift-squids-scream.md b/.changeset/swift-squids-scream.md
@@ -0,0 +1,5 @@
+---
+'typedoc-plugin-markdown': patch
+---
+
+- Fix missing return comments for const functions (#656)
diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts
@@ -34,9 +34,10 @@ export function signature(
     });
   }
   if (modelComments && model.parent?.comment?.blockTags) {
-    modelComments = Object.assign(modelComments, {
-      blockTags: model.parent.comment.blockTags,
-    });
+    modelComments.blockTags = [
+      ...(model.parent?.comment?.blockTags || []),
+      ...(model.comment?.blockTags || []),
+    ];
   }
 
   if (modelComments) {

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap
@@ -743,6 +743,8 @@ constFunctionWithReturns comments
 
 \`boolean\`
 
+Return comments
+
 ## Remarks
 
 Some remarks