Skip to content

Commit 31f72e4

Browse files
batchu5batchu5
committed
make jsdoc consistent across all components
1 parent a9ae2de commit 31f72e4

File tree

10 files changed

+40
-40
lines changed

10 files changed

+40
-40
lines changed

‎packages/components/docs/API.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Renders a WebSocket close connection method with optional pre- and post-executio
117117
| props.language | Language | Programming language used for method formatting. |
118118
| props.framework | string | Framework used, if any (e.g., 'quarkus' for Java). |
119119
| props.methodName | string | Name of the method to generate. |
120-
| props.methodParams | Array.<string> | List of parameters for the method. |
120+
| props.methodParams | Array.<string> | List of parameters for the method. |
121121
| props.preExecutionCode | string | Code to insert before the main function logic. |
122122
| props.postExecutionCode | string | Code to insert after the main function logic. |
123123
| props.indent | number | Indentation level for the method block. |
@@ -158,7 +158,7 @@ Component that renders WebSocket connection method for the specified programming
158158
| Name | Type | Description |
159159
|------|------|-------------|
160160
| props | Object | Component properties. |
161-
| props.language | SupportedLanguage | The programming language for which to generate connection code. |
161+
| props.language | Language | The programming language for which to generate connection code. |
162162
| props.title | string | The title of the WebSocket server. |
163163

164164

@@ -190,7 +190,7 @@ Renders the top-of-file dependency statements for the selected programming langu
190190
| props.language | Language | The programming language for which to render dependency statements. |
191191
| props.framework | string | The framework (e.g., &#x27;quarkus&#x27; for Java). |
192192
| props.role | string | The role (e.g., &#x27;client&#x27;, &#x27;connector&#x27; for Java). |
193-
| props.additionalDependencies | Array.&lt;string&gt; | Optional additional dependencies to include. |
193+
| props.additionalDependencies | Array.<string> | Optional additional dependencies to include. |
194194

195195

196196

@@ -270,7 +270,7 @@ Renders a WebSocket message handler method with optional pre- and post-execution
270270
| props | Object | Component props. |
271271
| props.language | Language | Programming language used for method formatting. |
272272
| props.methodName | string | Name of the method to generate. |
273-
| props.methodParams | Array.&lt;string&gt; | List of parameters for the method. |
273+
| props.methodParams | Array.<string> | List of parameters for the method. |
274274
| props.preExecutionCode | string | Code to insert before the main function logic. |
275275
| props.postExecutionCode | string | Code to insert after the main function logic. |
276276
| props.customMethodConfig | Object | Optional overrides for default method configuration. |
@@ -316,15 +316,15 @@ Generic Method rendering component.
316316
| props | Object | Component props. |
317317
| props.language | Language | Programming language used for method formatting. |
318318
| props.methodName | string | Name of the method. |
319-
| props.methodParams | Array.&lt;string&gt; | Method parameters. |
319+
| props.methodParams | Array.<string> | Method parameters. |
320320
| props.methodDocs | string | Optional documentation string. |
321321
| props.methodLogic | string | Core method logic. |
322322
| props.preExecutionCode | string | Code before main logic. |
323323
| props.postExecutionCode | string | Code after main logic. |
324324
| props.indent | number | Indentation for the method block. |
325325
| props.newLines | number | Number of new lines after method. |
326326
| props.customMethodConfig | Object | Optional custom syntax configuration for the current language. |
327-
| props.methodConfig | Record.&lt;Language, ({methodDocs: string, methodLogic: string}&amp;#124;Record.&lt;string, {methodDocs: string, methodLogic: string}&gt;)&gt; | Language-level or framework-level configuration. |
327+
| props.methodConfig | Record.<Language, ({methodDocs: (string&#124;undefined), methodLogic: (string&#124;undefined)}&#124;Record.<string, {methodDocs: (string&#124;undefined), methodLogic: (string&#124;undefined)}>)> | Language-level or framework-level configuration. |
328328
| props.framework | string | Framework name for nested configurations (e.g., &#x27;quarkus&#x27; for Java). |
329329

330330

@@ -407,7 +407,7 @@ Component that renders WebSocket onClose event handler for the specified program
407407
| Name | Type | Description |
408408
|------|------|-------------|
409409
| props | Object | Component properties. |
410-
| props.language | SupportedLanguage | The programming language for which to generate onClose handler code. |
410+
| props.language | Language | The programming language for which to generate onClose handler code. |
411411
| props.framework | string | Optional framework variant (e.g., &#x27;quarkus&#x27; for java). |
412412
| props.title | string | The title of the WebSocket server. |
413413

@@ -438,7 +438,7 @@ Component that renders WebSocket onError event handler for the specified program
438438
| Name | Type | Description |
439439
|------|------|-------------|
440440
| props | Object | Component properties. |
441-
| props.language | SupportedLanguage | The programming language for which to generate onError handler code. |
441+
| props.language | Language | The programming language for which to generate onError handler code. |
442442

443443

444444

@@ -464,7 +464,7 @@ Component that renders WebSocket onMessage event handler for the specified progr
464464
| Name | Type | Description |
465465
|------|------|-------------|
466466
| props | Object | Component properties. |
467-
| props.language | SupportedLanguage | The programming language for which to generate onMessage handler code. |
467+
| props.language | Language | The programming language for which to generate onMessage handler code. |
468468

469469

470470

@@ -490,7 +490,7 @@ Component that renders WebSocket onOpen event handler for the specified programm
490490
| Name | Type | Description |
491491
|------|------|-------------|
492492
| props | Object | Component properties. |
493-
| props.language | SupportedLanguage | The programming language for which to generate onOpen handler code. |
493+
| props.language | Language | The programming language for which to generate onOpen handler code. |
494494
| props.framework | string | Optional framework variant (e.g., &#x27;quarkus&#x27; for java). |
495495
| props.title | string | The title of the WebSocket server. |
496496

@@ -521,9 +521,9 @@ Component for rendering query parameter variables code.
521521
| Name | Type | Description |
522522
|------|------|-------------|
523523
| props | Object | Component props. |
524-
| props.language | SupportedLanguage | The target programming language. |
524+
| props.language | Language | The target programming language. |
525525
| props.framework | string | Optional framework for the language. |
526-
| props.queryParams | Array.&lt;Array.&lt;string&gt;&gt; | Array of query parameters, each represented as [paramName, paramType?]. |
526+
| props.queryParams | Array.<Array.<string>> | Array of query parameters, each represented as [paramName, paramType?]. |
527527

528528

529529

@@ -573,7 +573,7 @@ Renders a WebSocket error handler registration method with optional pre- and pos
573573
| props | Object | Component props. |
574574
| props.language | Language | Programming language used for method formatting. |
575575
| props.methodName | string | Name of the method to generate. |
576-
| props.methodParams | Array.&lt;string&gt; | List of parameters for the method. |
576+
| props.methodParams | Array.<string> | List of parameters for the method. |
577577
| props.preExecutionCode | string | Code to insert before the main function logic. |
578578
| props.postExecutionCode | string | Code to insert after the main function logic. |
579579
| props.customMethodConfig | Object | Optional overrides for default method configuration. |
@@ -615,7 +615,7 @@ Renders a WebSocket message handler registration method with optional pre- and p
615615
| props | Object | Component props. |
616616
| props.language | Language | Programming language used for method formatting. |
617617
| props.methodName | string | Name of the method to generate. |
618-
| props.methodParams | Array.&lt;string&gt; | List of parameters for the method. |
618+
| props.methodParams | Array.<string> | List of parameters for the method. |
619619
| props.preExecutionCode | string | Code to insert before the main function logic. |
620620
| props.postExecutionCode | string | Code to insert after the main function logic. |
621621

@@ -654,8 +654,8 @@ Generates both static and instance methods for sending messages through WebSocke
654654
| Name | Type | Description |
655655
|------|------|-------------|
656656
| props | Object | Component props. |
657-
| props.language | SupportedLanguage | The target programming language. |
658-
| props.sendOperations | Array.&lt;Object&gt; | Array of send operations from AsyncAPI document. |
657+
| props.language | Language | The target programming language. |
658+
| props.sendOperations | Array.<Object> | Array of send operations from AsyncAPI document. |
659659
| props.clientName | string | The name of the client class. |
660660

661661

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
| Name | Type | Description |
2929
|------|------|-------------|
3030
{{#each params}}
31-
| {{name}} | {{escapeType type.names.[0]}} | {{description}} |
31+
| {{name}} | {{{escapeType type.names.[0]}}} | {{description}} |
3232
{{/each}}
3333

3434
{{/if}}

‎packages/components/src/components/Connect.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ import { OnError } from './OnError';
55
import { OnClose } from './OnClose';
66

77
/**
8-
* @typedef {'python' | 'javascript' | 'dart'} SupportedLanguage
8+
* @typedef {'python' | 'javascript' | 'dart'} Language
99
* Supported programming languages for WebSocket connection method generation.
1010
*/
1111

1212
/**
1313
* Mapping of supported programming languages to their WebSocket connection method implementations.
1414
*
15-
* @type {Object.<SupportedLanguage, Function>}
15+
* @type {Object.<Language, Function>}
1616
*/
1717
const websocketConnectMethod = {
1818
javascript: (onOpenMethod, onMessageMethod, onErrorMethod, onCloseMethod) => {
@@ -95,7 +95,7 @@ Future<void> connect() async {
9595
* Component that renders WebSocket connection method for the specified programming language.
9696
*
9797
* @param {Object} props - Component properties.
98-
* @param {SupportedLanguage} props.language - The programming language for which to generate connection code.
98+
* @param {Language} props.language - The programming language for which to generate connection code.
9999
* @param {string} props.title - The title of the WebSocket server.
100100
*
101101
* @example

‎packages/components/src/components/MethodGenerator.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ const buildIndentedLogic = (logic, preExecutionCode, postExecutionCode, indentSi
7171
* @param {string} [props.postExecutionCode=''] - Code after main logic.
7272
* @param {number} [props.indent=2] - Indentation for the method block.
7373
* @param {number} [props.newLines=1] - Number of new lines after method.
74-
* @param {{ returnType: string, openingTag: string, closingTag: string, indentSize: number, parameterWrap: boolean }} [props.customMethodConfig] - Optional custom syntax configuration for the current language.
75-
* @param {Record<Language, { methodDocs: string, methodLogic: string } | Record<string, { methodDocs: string, methodLogic: string }>>} [props.methodConfig] - Language-level or framework-level configuration.
74+
* @param {{ returnType: string | undefined, openingTag: string | undefined, closingTag: string | undefined, indentSize: number | undefined, parameterWrap: boolean | undefined }} [props.customMethodConfig] - Optional custom syntax configuration for the current language.
75+
* @param {Record<Language, { methodDocs: string | undefined, methodLogic: string | undefined } | Record<string, { methodDocs: string | undefined, methodLogic: string | undefined }>>} [props.methodConfig] - Language-level or framework-level configuration.
7676
* @param {string} [props.framework] - Framework name for nested configurations (e.g., 'quarkus' for Java).
7777
*
7878
* @example

‎packages/components/src/components/OnClose.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import { Text } from '@asyncapi/generator-react-sdk';
22

33
/**
4-
* @typedef {'python' | 'javascript' | 'dart' | 'java' } SupportedLanguage
4+
* @typedef {'python' | 'javascript' | 'dart' | 'java' } Language
55
* Supported programming languages for WebSocket onClose handler generation.
66
*/
77

88
/**
99
* Mapping of supported programming languages to their WebSocket onClose event handler implementations.
1010
*
11-
* @type {Object.<SupportedLanguage, Function>}
11+
* @type {Object.<Language, Function>}
1212
*/
1313
const websocketOnCloseMethod = {
1414
javascript: (title) => {
@@ -61,7 +61,7 @@ const resolveCloseConfig = (language, framework = '') => {
6161
* Component that renders WebSocket onClose event handler for the specified programming language.
6262
*
6363
* @param {Object} props - Component properties.
64-
* @param {SupportedLanguage} props.language - The programming language for which to generate onClose handler code.
64+
* @param {Language} props.language - The programming language for which to generate onClose handler code.
6565
* @param {string} [props.framework=''] - Optional framework variant (e.g., 'quarkus' for java).
6666
* @param {string} props.title - The title of the WebSocket server.
6767
*

‎packages/components/src/components/OnError.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import { Text } from '@asyncapi/generator-react-sdk';
22

33
/**
4-
* @typedef {'python' | 'javascript' | 'dart'} SupportedLanguage
4+
* @typedef {'python' | 'javascript' | 'dart'} Language
55
* Supported programming languages for WebSocket onError handler generation.
66
*/
77

88
/**
99
* Mapping of supported programming languages to their WebSocket onError event handler implementations.
1010
*
11-
* @type {Object.<SupportedLanguage, Function>}
11+
* @type {Object.<Language, Function>}
1212
*/
1313
const websocketOnErrorMethod = {
1414
javascript: () => {
@@ -52,7 +52,7 @@ const websocketOnErrorMethod = {
5252
* Component that renders WebSocket onError event handler for the specified programming language.
5353
*
5454
* @param {Object} props - Component properties.
55-
* @param {SupportedLanguage} props.language - The programming language for which to generate onError handler code.
55+
* @param {Language} props.language - The programming language for which to generate onError handler code.
5656
*
5757
* @example
5858
* const language = "java"

‎packages/components/src/components/OnMessage.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import { Text } from '@asyncapi/generator-react-sdk';
22

33
/**
4-
* @typedef {'python' | 'javascript' | 'dart'} SupportedLanguage
4+
* @typedef {'python' | 'javascript' | 'dart'} Language
55
* Supported programming languages for WebSocket onMessage handler generation.
66
*/
77

88
/**
99
* Mapping of supported programming languages to their WebSocket onMessage event handler implementations.
1010
*
11-
* @type {Object.<SupportedLanguage, Function>}
11+
* @type {Object.<Language, Function>}
1212
*/
1313
const websocketOnMessageMethod = {
1414
javascript: () => {
@@ -80,7 +80,7 @@ const websocketOnMessageMethod = {
8080
* Component that renders WebSocket onMessage event handler for the specified programming language.
8181
*
8282
* @param {Object} props - Component properties.
83-
* @param {SupportedLanguage} props.language - The programming language for which to generate onMessage handler code.
83+
* @param {Language} props.language - The programming language for which to generate onMessage handler code.
8484
*
8585
* @example
8686
* const language = "java"

‎packages/components/src/components/OnOpen.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import { Text } from '@asyncapi/generator-react-sdk';
22

33
/**
4-
* @typedef {'python' | 'javascript' | 'java'} SupportedLanguage
4+
* @typedef {'python' | 'javascript' | 'java'} Language
55
* Supported programming languages for WebSocket onOpen handler generation.
66
*/
77

88
/**
99
* Mapping of supported programming languages to their WebSocket onOpen event handler implementations.
1010
*
11-
* @type {Object.<SupportedLanguage, Function>}
11+
* @type {Object.<Language, Function>}
1212
*/
1313
const websocketOnOpenMethod = {
1414
javascript: (title) => {
@@ -53,7 +53,7 @@ const resolveOpenConfig = (language, framework = '') => {
5353
* Component that renders WebSocket onOpen event handler for the specified programming language.
5454
*
5555
* @param {Object} props - Component properties.
56-
* @param {SupportedLanguage} props.language - The programming language for which to generate onOpen handler code.
56+
* @param {Language} props.language - The programming language for which to generate onOpen handler code.
5757
* @param {string} [props.framework=''] - Optional framework variant (e.g., 'quarkus' for java).
5858
* @param {string} props.title - The title of the WebSocket server.
5959
*

‎packages/components/src/components/QueryParamsVariables.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { Text } from '@asyncapi/generator-react-sdk';
22
import { toCamelCase } from '@asyncapi/generator-helpers';
33

44
/**
5-
* @typedef {'python' | 'java' | 'javascript'} SupportedLanguage
5+
* @typedef {'python' | 'java' | 'javascript'} Language
66
* Supported programming languages for query parameter generation.
77
*/
88

@@ -18,7 +18,7 @@ import { toCamelCase } from '@asyncapi/generator-helpers';
1818
* Language and framework specific logic for generating query parameter code.
1919
* Each entry returns a {@link QueryParamCodeBlock}.
2020
*
21-
* @type {Record<SupportedLanguage, Record<string, function>|function>}
21+
* @type {Record<Language, Record<string, function>|function>}
2222
*/
2323
const queryParamLogicConfig = {
2424
python: (param) => {
@@ -91,7 +91,7 @@ const queryParamLogicConfig = {
9191
* Resolve the appropriate query parameter configuration function based on language and framework.
9292
*
9393
* @private
94-
* @param {SupportedLanguage} language - The target programming language.
94+
* @param {Language} language - The target programming language.
9595
* @param {string} [framework=''] - Optional framework (e.g., 'quarkus' for Java).
9696
* @returns {function} The configuration function for generating query parameter code.
9797
*/
@@ -109,7 +109,7 @@ function resolveQueryParamLogic(language, framework = '') {
109109
* Component for rendering query parameter variables code.
110110
*
111111
* @param {Object} props - Component props.
112-
* @param {SupportedLanguage} props.language - The target programming language.
112+
* @param {Language} props.language - The target programming language.
113113
* @param {string} [props.framework=''] - Optional framework for the language.
114114
* @param {string[][]} props.queryParams - Array of query parameters, each represented as [paramName, paramType?].
115115
* @returns {React.ReactNode[]|null} Array of Text components for each query parameter, or null if queryParams is invalid.

‎packages/components/src/components/SendOperations.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { Text } from '@asyncapi/generator-react-sdk';
22
import { toSnakeCase } from '@asyncapi/generator-helpers';
33

44
/**
5-
* @typedef {'python' | 'javascript'} SupportedLanguage
5+
* @typedef {'python' | 'javascript'} Language
66
* Supported programming languages for WebSocket send operation generation.
77
*/
88

@@ -120,7 +120,7 @@ static ${methodName}(message, socket, schemas) {
120120
* Generates both static and instance methods for sending messages through WebSocket connections.
121121
*
122122
* @param {Object} props - Component props.
123-
* @param {SupportedLanguage} props.language - The target programming language.
123+
* @param {Language} props.language - The target programming language.
124124
* @param {Array<Object>} props.sendOperations - Array of send operations from AsyncAPI document.
125125
* @param {string} props.clientName - The name of the client class.
126126
*

0 commit comments

Comments
 (0)