feat: include parameter details in Swift docstrings (#118)

rudderlabs · Jan 21, 2025 · 5fdfa31 · 5fdfa31
1 parent 456921d
commit 5fdfa31
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 3 deletions.
diff --git a/src/generators/swift/swift.ts b/src/generators/swift/swift.ts
@@ -2,6 +2,7 @@ import { Type, Schema } from '../ast.js';
 import Handlebars from 'handlebars';
 import { Generator, BasePropertyContext, GeneratorClient } from '../gen.js';
 import lodash from 'lodash';
+import { registerPartial } from '../../templates.js';
 
 const { camelCase, upperFirst } = lodash;
 
@@ -61,6 +62,10 @@ export const swift: Generator<
     allowedIdentifierChars: 'A-Za-z0-9_$',
   },
   setup: async () => {
+    await registerPartial(
+      'generators/swift/templates/functionDocumentation.hbs',
+      'functionDocumentation',
+    );
     Handlebars.registerHelper('propertiesDictionary', generatePropertiesDictionary);
     Handlebars.registerHelper('functionCall', generateFunctionCall);
     Handlebars.registerHelper('functionSignature', generateFunctionSignature);

diff --git a/src/generators/swift/templates/analytics.swift.hbs b/src/generators/swift/templates/analytics.swift.hbs
@@ -13,9 +13,7 @@ class RudderTyperAnalytics {
         {{functionCall "RudderTyperAnalytics" functionName properties "options" "RSOption()"}}
     }
 
-    {{#if functionDescription}}
-    /// {{functionDescription}}
-    {{/if}}
+    {{> functionDocumentation }}
     static func {{functionSignature functionName properties true}} {
         {{indent "        " (propertiesDictionary properties)}}
 

diff --git a/src/generators/swift/templates/functionDocumentation.hbs b/src/generators/swift/templates/functionDocumentation.hbs
@@ -0,0 +1,13 @@
+/**
+ {{#if functionDescription}}
+  {{functionDescription}}
+ {{else}}
+  Fires a '{{functionName}}' track call.
+ {{/if}}
+
+  - Parameters:
+        {{#each properties}}
+    - {{name}}: {{#if isRequired}}{{type}} (required){{else}}{{type}} (optional){{/if}}{{#if description}} - {{description}}{{/if}}
+        {{/each}}
+    - options: Event-level options (optional)
+ */