fix(core): add parentheses on function names in type declaration tabl…

…e views (#696)
typedoc2md · Sep 30, 2024 · bf130cb · bf130cb
1 parent 9c90566
commit bf130cb
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/.changeset/quiet-ducks-thank.md b/.changeset/quiet-ducks-thank.md
@@ -0,0 +1,5 @@
+---
+'typedoc-plugin-markdown': patch
+---
+
+- Add parentheses on function names in type declaration table views (#696)
diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts
@@ -51,8 +51,14 @@ export function typeDeclarationTable(
   declarations.forEach((declaration: DeclarationReflection) => {
     const row: string[] = [];
 
+    const name: string[] = [declaration.name];
+
+    if (declaration.signatures?.length) {
+      name.push('()');
+    }
+
     const optional = declaration.flags.isOptional ? '?' : '';
-    row.push(`${backTicks(declaration.name)}${optional}`);
+    row.push(`${backTicks(name.join(''))}${optional}`);
 
     row.push(this.partials.someType(declaration.type));
 

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
@@ -237,7 +237,7 @@ Comments for LiteralType
 | \`set accessorA\` | \`void\` | Comments for accessorA setter |
 | \`get accessorB\` | \`string\` | - |
 | \`set accessorB\` | \`void\` | - |
-| \`someFunction\` | [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`any\`\\> | Comments for someFunction |
+| \`someFunction()\` | [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`any\`\\> | Comments for someFunction |
 
 ## Source