docs: add signature

actcoding · Aug 21, 2024 · a8220b4 · a8220b4
1 parent d85f2f4
commit a8220b4
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/scripts/gen-docs-api.ts b/scripts/gen-docs-api.ts
@@ -19,12 +19,17 @@ type Options = {
 
 const template = compile(`
 Title:   <%= name %>
-Summary: <%= description %>
 
-# \`<%= name %>(): <%= returns.type %>\`
+# \`<%= name %>\`
 
 > <%= description %>
 
+## Signature
+
+\`\`\`js
+<%= name %>(<%= signature %>): <%= returns.type %>
+\`\`\`
+
 ## Return value
 
 \`<%= returns.type %>\`
@@ -126,6 +131,7 @@ program.description('Generate documentation files for all exported API symbols.'
                     .process(await template({
                         name: node.declaration.id.name,
                         description: parsedComment.description,
+                        signature: params.map(param => `${param.name}: ${param.type}`).join(', '),
                         params, returns, examples,
                     }))