fix(core): expose comment for arrow functions in type declarations (#670

)
typedoc2md · Aug 15, 2024 · 7afe341 · 7afe341
1 parent 099ef16
commit 7afe341
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 7 deletions.
diff --git a/.changeset/four-lions-vanish.md b/.changeset/four-lions-vanish.md
@@ -0,0 +1,5 @@
+---
+'typedoc-plugin-markdown': patch
+---
+
+- Expose comment for arrow functions in type declarations (#670)
diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts
@@ -39,11 +39,7 @@ export function declaration(
   const typeDeclaration = (model.type as any)
     ?.declaration as DeclarationReflection;
 
-  const showComments = !typeDeclaration?.signatures?.every((signature) =>
-    Boolean(signature.comment),
-  );
-
-  if (showComments && model.comment) {
+  if (model.comment) {
     md.push(
       this.partials.comment(model.comment, {
         headingLevel: opts.headingLevel,
@@ -161,7 +157,7 @@ export function declaration(
     }
   }
 
-  if (showComments && model.comment) {
+  if (model.comment) {
     md.push(
       this.partials.comment(model.comment, {
         headingLevel: opts.headingLevel,

diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/types.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/types.ts
@@ -129,6 +129,10 @@ export type LiteralType = {
    * @param param
    */
   someFunction(param: string): Promise<any>;
+  /**
+   * Comments for someFunctionWithArrow
+   */
+  someFunctionWithArrow: () => string;
   /**
    * Comments for accessorA getter
    */

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/objects-and-params.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/objects-and-params.spec.ts.snap
@@ -488,12 +488,22 @@ bar: number;
 exports[`Objects And Params should compile literal type: (Output File Strategy "members") (Option Group "1") 1`] = `
 "# Type Alias: LiteralType
 
-> **LiteralType**: \\{\`x\`: \`string\`;\`y\`: \\{\`x\`: \`string\`;\`y\`: \`boolean\` \\| \`string\`;\`z\`: (\`x\`: \`string\`) => \`string\`; \\};\`z\`: (\`x\`: \`string\`) => \`string\`;get set \`accessorA\`: [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`string\`\\>;get set \`accessorB\`: \`string\`;\`someFunction\`: [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`any\`\\>; \\}
+> **LiteralType**: \\{\`someFunctionWithArrow\`: () => \`string\`;\`x\`: \`string\`;\`y\`: \\{\`x\`: \`string\`;\`y\`: \`boolean\` \\| \`string\`;\`z\`: (\`x\`: \`string\`) => \`string\`; \\};\`z\`: (\`x\`: \`string\`) => \`string\`;get set \`accessorA\`: [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`string\`\\>;get set \`accessorB\`: \`string\`;\`someFunction\`: [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`any\`\\>; \\}
 
 Comments for LiteralType
 
 ## Type declaration
 
+### someFunctionWithArrow()
+
+> **someFunctionWithArrow**: () => \`string\`
+
+Comments for someFunctionWithArrow
+
+#### Returns
+
+\`string\`
+
 ### x
 
 > **x**: \`string\`
@@ -595,6 +605,7 @@ exports[`Objects And Params should compile literal type: (Output File Strategy "
 
 \`\`\`ts
 type LiteralType: {
+  someFunctionWithArrow: () => string;
   x: string;
   y: {
      x: string;
@@ -612,6 +623,18 @@ Comments for LiteralType
 
 ## Type declaration
 
+### someFunctionWithArrow()
+
+\`\`\`ts
+someFunctionWithArrow: () => string;
+\`\`\`
+
+Comments for someFunctionWithArrow
+
+#### Returns
+
+\`string\`
+
 ### x
 
 \`\`\`ts

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap
@@ -103,6 +103,16 @@ Comments for LiteralType
 
 ## Type declaration
 
+### someFunctionWithArrow()
+
+> **someFunctionWithArrow**: () => \`string\`
+
+Comments for someFunctionWithArrow
+
+#### Returns
+
+\`string\`
+
 ### x
 
 > **x**: \`string\`
@@ -216,6 +226,7 @@ Comments for LiteralType
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
+| \`someFunctionWithArrow\` | () => \`string\` | Comments for someFunctionWithArrow |
 | \`x\` | \`string\` | comment for x |
 | \`y\` | \`object\` | comment for y |
 | \`y.x\` | \`string\` | comment for y.x |