Skip to content

Commit f032883

Browse files
batchu5batchu5
committed
remove jsdoc helper
1 parent c15df03 commit f032883

File tree

5 files changed

+104
-122
lines changed

5 files changed

+104
-122
lines changed

‎apps/generator/docs/api_components.md‎

Lines changed: 101 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -107,14 +107,14 @@ Renders a WebSocket close connection method with optional pre- and post-executio
107107

108108
| Name | Type | Description |
109109
|------|------|-------------|
110-
| props | <code>Object</code> | Component props. |
111-
| props.language | <code>Language</code> | Programming language used for method formatting. |
112-
| props.framework | <code>string</code> | Framework used, if any (e.g., &#x27;quarkus&#x27; for Java). |
113-
| props.methodName | <code>string</code> | Name of the method to generate. |
114-
| props.methodParams | <code>Array.&lt;string&gt;</code> | List of parameters for the method. |
115-
| props.preExecutionCode | <code>string</code> | Code to insert before the main function logic. |
116-
| props.postExecutionCode | <code>string</code> | Code to insert after the main function logic. |
117-
| props.indent | <code>number</code> | Indentation level for the method block. |
110+
| props | `Object` | Component props. |
111+
| props.language | `Language` | Programming language used for method formatting. |
112+
| props.framework | `string` | Framework used, if any (e.g., &#x27;quarkus&#x27; for Java). |
113+
| props.methodName | `string` | Name of the method to generate. |
114+
| props.methodParams | `Array.<string>` | List of parameters for the method. |
115+
| props.preExecutionCode | `string` | Code to insert before the main function logic. |
116+
| props.postExecutionCode | `string` | Code to insert after the main function logic. |
117+
| props.indent | `number` | Indentation level for the method block. |
118118

119119

120120

@@ -163,9 +163,9 @@ Renders a WebSocket connection method for the specified programming language.
163163

164164
| Name | Type | Description |
165165
|------|------|-------------|
166-
| props | <code>Object</code> | Component props. |
167-
| props.language | <code>Language</code> | The programming language for which to generate connection code. |
168-
| props.title | <code>string</code> | The title of the WebSocket server. |
166+
| props | `Object` | Component props. |
167+
| props.language | `Language` | The programming language for which to generate connection code. |
168+
| props.title | `string` | The title of the WebSocket server. |
169169

170170

171171

@@ -204,11 +204,11 @@ Renders the top-of-file dependency statements for the selected programming langu
204204

205205
| Name | Type | Description |
206206
|------|------|-------------|
207-
| props | <code>Object</code> | Component props. |
208-
| props.language | <code>Language</code> | The programming language for which to render dependency statements. |
209-
| props.framework | <code>string</code> | The framework (e.g., &#x27;quarkus&#x27; for Java). |
210-
| props.role | <code>string</code> | The role (e.g., &#x27;client&#x27;, &#x27;connector&#x27; for Java). |
211-
| props.additionalDependencies | <code>Array.&lt;string&gt;</code> | Optional additional dependencies to include. |
207+
| props | `Object` | Component props. |
208+
| props.language | `Language` | The programming language for which to render dependency statements. |
209+
| props.framework | `string` | The framework (e.g., &#x27;quarkus&#x27; for Java). |
210+
| props.role | `string` | The role (e.g., &#x27;client&#x27;, &#x27;connector&#x27; for Java). |
211+
| props.additionalDependencies | `Array.<string>` | Optional additional dependencies to include. |
212212

213213

214214

@@ -250,10 +250,10 @@ Renders a file header with metadata information such as title, version, protocol
250250

251251
| Name | Type | Description |
252252
|------|------|-------------|
253-
| props | <code>Object</code> | Component props. |
254-
| props.info | <code>Object</code> | Info object from the AsyncAPI document. |
255-
| props.server | <code>Object</code> | Server object from the AsyncAPI document. |
256-
| props.language | <code>Language</code> | Programming language used for comment formatting. |
253+
| props | `Object` | Component props. |
254+
| props.info | `Object` | Info object from the AsyncAPI document. |
255+
| props.server | `Object` | Server object from the AsyncAPI document. |
256+
| props.language | `Language` | Programming language used for comment formatting. |
257257

258258

259259

@@ -302,13 +302,13 @@ Renders a WebSocket message handler method with optional pre- and post-execution
302302

303303
| Name | Type | Description |
304304
|------|------|-------------|
305-
| props | <code>Object</code> | Component props. |
306-
| props.language | <code>Language</code> | Programming language used for method formatting. |
307-
| props.methodName | <code>string</code> | Name of the method to generate. |
308-
| props.methodParams | <code>Array.&lt;string&gt;</code> | List of parameters for the method. |
309-
| props.preExecutionCode | <code>string</code> | Code to insert before the main function logic. |
310-
| props.postExecutionCode | <code>string</code> | Code to insert after the main function logic. |
311-
| props.customMethodConfig | <code>Object</code> | Optional overrides for default method configuration. |
305+
| props | `Object` | Component props. |
306+
| props.language | `Language` | Programming language used for method formatting. |
307+
| props.methodName | `string` | Name of the method to generate. |
308+
| props.methodParams | `Array.<string>` | List of parameters for the method. |
309+
| props.preExecutionCode | `string` | Code to insert before the main function logic. |
310+
| props.postExecutionCode | `string` | Code to insert after the main function logic. |
311+
| props.customMethodConfig | `Object` | Optional overrides for default method configuration. |
312312

313313

314314

@@ -360,19 +360,19 @@ Renders a language-specific formatted method definition.
360360

361361
| Name | Type | Description |
362362
|------|------|-------------|
363-
| props | <code>Object</code> | Component props. |
364-
| props.language | <code>Language</code> | Programming language used for method formatting. |
365-
| props.methodName | <code>string</code> | Name of the method. |
366-
| props.methodParams | <code>Array.&lt;string&gt;</code> | Method parameters. |
367-
| props.methodDocs | <code>string</code> | Optional documentation string. |
368-
| props.methodLogic | <code>string</code> | Core method logic. |
369-
| props.preExecutionCode | <code>string</code> | Code before main logic. |
370-
| props.postExecutionCode | <code>string</code> | Code after main logic. |
371-
| props.indent | <code>number</code> | Indentation for the method block. |
372-
| props.newLines | <code>number</code> | Number of new lines after method. |
373-
| props.customMethodConfig | <code>Object</code> | Optional custom syntax configuration for the current language. |
374-
| props.methodConfig | <code>Record.&lt;Language, (&#123;methodDocs: (string&#124;undefined), methodLogic: (string&#124;undefined)&#125;&#124;Record.&lt;string, &#123;methodDocs: (string&#124;undefined), methodLogic: (string&#124;undefined)&#125;&gt;)&gt;</code> | Language-level or framework-level configuration. |
375-
| props.framework | <code>string</code> | Framework name for nested configurations (e.g., &#x27;quarkus&#x27; for Java). |
363+
| props | `Object` | Component props. |
364+
| props.language | `Language` | Programming language used for method formatting. |
365+
| props.methodName | `string` | Name of the method. |
366+
| props.methodParams | `Array.<string>` | Method parameters. |
367+
| props.methodDocs | `string` | Optional documentation string. |
368+
| props.methodLogic | `string` | Core method logic. |
369+
| props.preExecutionCode | `string` | Code before main logic. |
370+
| props.postExecutionCode | `string` | Code after main logic. |
371+
| props.indent | `number` | Indentation for the method block. |
372+
| props.newLines | `number` | Number of new lines after method. |
373+
| props.customMethodConfig | `Object` | Optional custom syntax configuration for the current language. |
374+
| props.methodConfig | `Object` | Language-level or framework-level configuration. |
375+
| props.framework | `string` | Framework name for nested configurations (e.g., &#x27;quarkus&#x27; for Java). |
376376

377377

378378

@@ -427,12 +427,12 @@ Renders an array of model files based on the AsyncAPI document.
427427

428428
| Name | Type | Description |
429429
|------|------|-------------|
430-
| props | <code>Object</code> | Component props. |
431-
| props.asyncapi | <code>AsyncAPIDocumentInterface</code> | Parsed AsyncAPI document object. |
432-
| props.language | <code>Language</code> | Target programming language for the generated models. |
433-
| props.format | <code>Format</code> | Naming format for generated files. |
434-
| props.presets | <code>Object</code> | Custom presets for the generator instance. |
435-
| props.constraints | <code>Object</code> | Custom constraints for the generator instance. |
430+
| props | `Object` | Component props. |
431+
| props.asyncapi | `AsyncAPIDocumentInterface` | Parsed AsyncAPI document object. |
432+
| props.language | `Language` | Target programming language for the generated models. |
433+
| props.format | `Format` | Naming format for generated files. |
434+
| props.presets | `Object` | Custom presets for the generator instance. |
435+
| props.constraints | `Object` | Custom constraints for the generator instance. |
436436

437437

438438

@@ -481,10 +481,10 @@ Renders a WebSocket onClose event handler for the specified programming language
481481

482482
| Name | Type | Description |
483483
|------|------|-------------|
484-
| props | <code>Object</code> | Component props. |
485-
| props.language | <code>Language</code> | The programming language for which to generate onClose handler code. |
486-
| props.framework | <code>string</code> | Framework variant; required for framework-specific languages (e.g., &#x27;quarkus&#x27; for java). |
487-
| props.title | <code>string</code> | The title of the WebSocket server. |
484+
| props | `Object` | Component props. |
485+
| props.language | `Language` | The programming language for which to generate onClose handler code. |
486+
| props.framework | `string` | Framework variant; required for framework-specific languages (e.g., &#x27;quarkus&#x27; for java). |
487+
| props.title | `string` | The title of the WebSocket server. |
488488

489489

490490

@@ -525,8 +525,8 @@ Renders a WebSocket onError event handler for the specified programming language
525525

526526
| Name | Type | Description |
527527
|------|------|-------------|
528-
| props | <code>Object</code> | Component props. |
529-
| props.language | <code>Language</code> | The programming language for which to generate onError handler code. |
528+
| props | `Object` | Component props. |
529+
| props.language | `Language` | The programming language for which to generate onError handler code. |
530530

531531

532532

@@ -561,8 +561,8 @@ Renders a WebSocket onMessage event handler for the specified programming langua
561561

562562
| Name | Type | Description |
563563
|------|------|-------------|
564-
| props | <code>Object</code> | Component props. |
565-
| props.language | <code>Language</code> | The programming language for which to generate onMessage handler code. |
564+
| props | `Object` | Component props. |
565+
| props.language | `Language` | The programming language for which to generate onMessage handler code. |
566566

567567

568568

@@ -597,10 +597,10 @@ Renders a WebSocket onOpen event handler for the specified programming language.
597597

598598
| Name | Type | Description |
599599
|------|------|-------------|
600-
| props | <code>Object</code> | Component props. |
601-
| props.language | <code>Language</code> | The programming language for which to generate onOpen handler code. |
602-
| props.framework | <code>string</code> | Optional framework variant (e.g., &#x27;quarkus&#x27; for java). |
603-
| props.title | <code>string</code> | The title of the WebSocket server. |
600+
| props | `Object` | Component props. |
601+
| props.language | `Language` | The programming language for which to generate onOpen handler code. |
602+
| props.framework | `string` | Optional framework variant (e.g., &#x27;quarkus&#x27; for java). |
603+
| props.title | `string` | The title of the WebSocket server. |
604604

605605

606606

@@ -641,10 +641,10 @@ Renders query parameter variables code blocks.
641641

642642
| Name | Type | Description |
643643
|------|------|-------------|
644-
| props | <code>Object</code> | Component props. |
645-
| props.language | <code>Language</code> | The target programming language. |
646-
| props.framework | <code>string</code> | Optional framework for the language. |
647-
| props.queryParams | <code>Array.&lt;Array.&lt;string&gt;&gt;</code> | Array of query parameters, each represented as [paramName, paramType?]. |
644+
| props | `Object` | Component props. |
645+
| props.language | `Language` | The target programming language. |
646+
| props.framework | `string` | Optional framework for the language. |
647+
| props.queryParams | `Array.<Array.<string>>` | Array of query parameters, each represented as [paramName, paramType?]. |
648648

649649

650650

@@ -700,8 +700,8 @@ Renders a list of AsyncAPI operations with their headers and message examples.
700700

701701
| Name | Type | Description |
702702
|------|------|-------------|
703-
| props | <code>Object</code> | Component Props |
704-
| props.operations | <code>Array.&lt;Object&gt;</code> | Array of AsyncAPI Operation objects. |
703+
| props | `Object` | Component Props |
704+
| props.operations | `Array.<Object>` | Array of AsyncAPI Operation objects. |
705705

706706

707707

@@ -745,8 +745,8 @@ Renders a list of core WebSocket client methods for a given target language.
745745

746746
| Name | Type | Description |
747747
|------|------|-------------|
748-
| props | <code>Object</code> | Component props |
749-
| props.language | <code>Language</code> | Target language used to select method names. |
748+
| props | `Object` | Component props |
749+
| props.language | `Language` | Target language used to select method names. |
750750

751751

752752

@@ -781,8 +781,8 @@ Renders the Installation Command for a given language.
781781

782782
| Name | Type | Description |
783783
|------|------|-------------|
784-
| props | <code>Object</code> | Component props |
785-
| props.language | <code>Language</code> | The programming language for which to generate Installation Command. |
784+
| props | `Object` | Component props |
785+
| props.language | `Language` | The programming language for which to generate Installation Command. |
786786

787787

788788

@@ -817,8 +817,8 @@ Renders Message Examples of a given AsyncAPI operation.
817817

818818
| Name | Type | Description |
819819
|------|------|-------------|
820-
| props | <code>Object</code> | Component Props |
821-
| props.operation | <code>Object</code> | An AsyncAPI Operation object. |
820+
| props | `Object` | Component Props |
821+
| props.operation | `Object` | An AsyncAPI Operation object. |
822822

823823

824824

@@ -865,8 +865,8 @@ Renders a header section for a single AsyncAPI operation.
865865

866866
| Name | Type | Description |
867867
|------|------|-------------|
868-
| props | <code>Object</code> | Component properties. |
869-
| props.operation | <code>Object</code> | An AsyncAPI Operation object. |
868+
| props | `Object` | Component properties. |
869+
| props.operation | `Object` | An AsyncAPI Operation object. |
870870

871871

872872

@@ -913,10 +913,10 @@ Renders an overview section for a WebSocket client. Displays the API description
913913

914914
| Name | Type | Description |
915915
|------|------|-------------|
916-
| props | <code>Object</code> | Component props |
917-
| props.info | <code>Object</code> | Info object from the AsyncAPI document. |
918-
| props.title | <code>string</code> | Title from the AsyncAPI document. |
919-
| props.serverUrl | <code>string</code> | ServerUrl from a specific server from the AsyncAPI document. |
916+
| props | `Object` | Component props |
917+
| props.info | `Object` | Info object from the AsyncAPI document. |
918+
| props.title | `string` | Title from the AsyncAPI document. |
919+
| props.serverUrl | `string` | ServerUrl from a specific server from the AsyncAPI document. |
920920

921921

922922

@@ -970,10 +970,10 @@ Renders a README.md file for a given AsyncAPI document. Composes multiple sectio
970970

971971
| Name | Type | Description |
972972
|------|------|-------------|
973-
| props | <code>Object</code> | Component props |
974-
| props.asyncapi | <code>AsyncAPIDocumentInterface</code> | Parsed AsyncAPI document instance. |
975-
| props.params | <code>Object</code> | Generator parameters used to customize output |
976-
| props.language | <code>Language</code> | Target language used to render language-specific sections. |
973+
| props | `Object` | Component props |
974+
| props.asyncapi | `AsyncAPIDocumentInterface` | Parsed AsyncAPI document instance. |
975+
| props.params | `Object` | Generator parameters used to customize output |
976+
| props.language | `Language` | Target language used to render language-specific sections. |
977977

978978

979979

@@ -1025,10 +1025,10 @@ Renders a usage example snippet for a generated WebSocket client in a given lang
10251025

10261026
| Name | Type | Description |
10271027
|------|------|-------------|
1028-
| props | <code>Object</code> | Component props |
1029-
| props.clientName | <code>string</code> | The exported name of the client. |
1030-
| props.clientFileName | <code>string</code> | The file name where the client is defined. |
1031-
| props.language | <code>Language</code> | The target language for which to render the usage snippet |
1028+
| props | `Object` | Component props |
1029+
| props.clientName | `string` | The exported name of the client. |
1030+
| props.clientFileName | `string` | The file name where the client is defined. |
1031+
| props.language | `Language` | The target language for which to render the usage snippet |
10321032

10331033

10341034

@@ -1069,13 +1069,13 @@ Renders a WebSocket error handler registration method with optional pre- and pos
10691069

10701070
| Name | Type | Description |
10711071
|------|------|-------------|
1072-
| props | <code>Object</code> | Component props. |
1073-
| props.language | <code>Language</code> | Programming language used for method formatting. |
1074-
| props.methodName | <code>string</code> | Name of the method to generate. |
1075-
| props.methodParams | <code>Array.&lt;string&gt;</code> | List of parameters for the method. |
1076-
| props.preExecutionCode | <code>string</code> | Code to insert before the main function logic. |
1077-
| props.postExecutionCode | <code>string</code> | Code to insert after the main function logic. |
1078-
| props.customMethodConfig | <code>Object</code> | Optional overrides for default method configuration. |
1072+
| props | `Object` | Component props. |
1073+
| props.language | `Language` | Programming language used for method formatting. |
1074+
| props.methodName | `string` | Name of the method to generate. |
1075+
| props.methodParams | `Array.<string>` | List of parameters for the method. |
1076+
| props.preExecutionCode | `string` | Code to insert before the main function logic. |
1077+
| props.postExecutionCode | `string` | Code to insert after the main function logic. |
1078+
| props.customMethodConfig | `Object` | Optional overrides for default method configuration. |
10791079

10801080

10811081

@@ -1122,12 +1122,12 @@ Renders a WebSocket message handler registration method with optional pre- and p
11221122

11231123
| Name | Type | Description |
11241124
|------|------|-------------|
1125-
| props | <code>Object</code> | Component props. |
1126-
| props.language | <code>Language</code> | Programming language used for method formatting. |
1127-
| props.methodName | <code>string</code> | Name of the method to generate. |
1128-
| props.methodParams | <code>Array.&lt;string&gt;</code> | List of parameters for the method. |
1129-
| props.preExecutionCode | <code>string</code> | Code to insert before the main function logic. |
1130-
| props.postExecutionCode | <code>string</code> | Code to insert after the main function logic. |
1125+
| props | `Object` | Component props. |
1126+
| props.language | `Language` | Programming language used for method formatting. |
1127+
| props.methodName | `string` | Name of the method to generate. |
1128+
| props.methodParams | `Array.<string>` | List of parameters for the method. |
1129+
| props.preExecutionCode | `string` | Code to insert before the main function logic. |
1130+
| props.postExecutionCode | `string` | Code to insert after the main function logic. |
11311131

11321132

11331133

@@ -1172,10 +1172,10 @@ Renders WebSocket send operation methods. Generates both static and instance met
11721172

11731173
| Name | Type | Description |
11741174
|------|------|-------------|
1175-
| props | <code>Object</code> | Component props. |
1176-
| props.language | <code>Language</code> | The target programming language. |
1177-
| props.sendOperations | <code>Array.&lt;Object&gt;</code> | Array of send operations from AsyncAPI document. |
1178-
| props.clientName | <code>string</code> | The name of the client class. |
1175+
| props | `Object` | Component props. |
1176+
| props.language | `Language` | The target programming language. |
1177+
| props.sendOperations | `Array.<Object>` | Array of send operations from AsyncAPI document. |
1178+
| props.clientName | `string` | The name of the client class. |
11791179

11801180

11811181

‎packages/components/jsdoc2md-handlebars/api.hbs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ weight: 77
2424
| Name | Type | Description |
2525
|------|------|-------------|
2626
{{#each params}}
27-
| {{name}} | <code>{{{escapeType type.names.[0]}}}</code> | {{description}} |
27+
| {{name}} | `{{{type.names.[0]}}}` | {{description}} |
2828
{{/each}}
2929

3030
{{/if}}

0 commit comments

Comments
 (0)