Skip to content

Commit efc670d

Browse files
committed
fix JSDoc to use props instead of params
1 parent 0334ec3 commit efc670d

File tree

7 files changed

+22
-22
lines changed

7 files changed

+22
-22
lines changed

packages/components/docs/API.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ Renders a WebSocket connection method for the specified programming language.
233233

234234
| Name | Type | Description |
235235
|------|------|-------------|
236-
| props | <code>Object</code> | Component properties. |
236+
| props | <code>Object</code> | Component props. |
237237
| props.language | <code>Language</code> | The programming language for which to generate connection code. |
238238
| props.title | <code>string</code> | The title of the WebSocket server. |
239239

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

482482
| Name | Type | Description |
483483
|------|------|-------------|
484-
| params | <code>Object</code> | The parameters for the function. |
485-
| params.asyncapi | <code>AsyncAPIDocumentInterface</code> | Parsed AsyncAPI document object. |
486-
| params.language | <code>Language</code> | Target programming language for the generated models. |
487-
| params.format | <code>Format</code> | Naming format for generated files. |
488-
| params.presets | <code>Object</code> | Custom presets for the generator instance. |
489-
| params.constraints | <code>Object</code> | Custom constraints for the generator instance. |
484+
| props | <code>Object</code> | Component props. |
485+
| props.asyncapi | <code>AsyncAPIDocumentInterface</code> | Parsed AsyncAPI document object. |
486+
| props.language | <code>Language</code> | Target programming language for the generated models. |
487+
| props.format | <code>Format</code> | Naming format for generated files. |
488+
| props.presets | <code>Object</code> | Custom presets for the generator instance. |
489+
| props.constraints | <code>Object</code> | Custom constraints for the generator instance. |
490490

491491

492492

@@ -535,7 +535,7 @@ Renders a WebSocket onClose event handler for the specified programming language
535535

536536
| Name | Type | Description |
537537
|------|------|-------------|
538-
| props | <code>Object</code> | Component properties. |
538+
| props | <code>Object</code> | Component props. |
539539
| props.language | <code>Language</code> | The programming language for which to generate onClose handler code. |
540540
| props.framework | <code>string</code> | Optional framework variant (e.g., &#x27;quarkus&#x27; for java). |
541541
| props.title | <code>string</code> | The title of the WebSocket server. |
@@ -575,7 +575,7 @@ Renders a WebSocket onError event handler for the specified programming language
575575

576576
| Name | Type | Description |
577577
|------|------|-------------|
578-
| props | <code>Object</code> | Component properties. |
578+
| props | <code>Object</code> | Component props. |
579579
| props.language | <code>Language</code> | The programming language for which to generate onError handler code. |
580580

581581

@@ -606,7 +606,7 @@ Renders a WebSocket onMessage event handler for the specified programming langua
606606

607607
| Name | Type | Description |
608608
|------|------|-------------|
609-
| props | <code>Object</code> | Component properties. |
609+
| props | <code>Object</code> | Component props. |
610610
| props.language | <code>Language</code> | The programming language for which to generate onMessage handler code. |
611611

612612

@@ -637,7 +637,7 @@ Renders a WebSocket onOpen event handler for the specified programming language.
637637

638638
| Name | Type | Description |
639639
|------|------|-------------|
640-
| props | <code>Object</code> | Component properties. |
640+
| props | <code>Object</code> | Component props. |
641641
| props.language | <code>Language</code> | The programming language for which to generate onOpen handler code. |
642642
| props.framework | <code>string</code> | Optional framework variant (e.g., &#x27;quarkus&#x27; for java). |
643643
| props.title | <code>string</code> | The title of the WebSocket server. |

packages/components/src/components/Connect.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Future<void> connect() async {
9494
/**
9595
* Renders a WebSocket connection method for the specified programming language.
9696
*
97-
* @param {Object} props - Component properties.
97+
* @param {Object} props - Component props.
9898
* @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
* @return {JSX.Element} A Text component containing the generated WebSocket connection code for the specified language.

packages/components/src/components/Models.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,12 @@ const formatHelpers = {
5151
/**
5252
* Renders an array of model files based on the AsyncAPI document.
5353
*
54-
* @param {Object} params - The parameters for the function.
55-
* @param {AsyncAPIDocumentInterface} params.asyncapi - Parsed AsyncAPI document object.
56-
* @param {Language} [params.language='python'] - Target programming language for the generated models.
57-
* @param {Format} [params.format='toPascalCase'] - Naming format for generated files.
58-
* @param {Object} [params.presets={}] - Custom presets for the generator instance.
59-
* @param {Object} [params.constraints={}] - Custom constraints for the generator instance.
54+
* @param {Object} props - Component props.
55+
* @param {AsyncAPIDocumentInterface} props.asyncapi - Parsed AsyncAPI document object.
56+
* @param {Language} [props.language='python'] - Target programming language for the generated models.
57+
* @param {Format} [props.format='toPascalCase'] - Naming format for generated files.
58+
* @param {Object} [props.presets={}] - Custom presets for the generator instance.
59+
* @param {Object} [props.constraints={}] - Custom constraints for the generator instance.
6060
*
6161
* @returns {Array<File>} Array of File components with generated model content.
6262
*

packages/components/src/components/OnClose.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ const resolveCloseConfig = (language, framework = '') => {
6060
/**
6161
* Renders a WebSocket onClose event handler for the specified programming language.
6262
*
63-
* @param {Object} props - Component properties.
63+
* @param {Object} props - Component props.
6464
* @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.

packages/components/src/components/OnError.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ const websocketOnErrorMethod = {
5151
/**
5252
* Renders a WebSocket onError event handler for the specified programming language.
5353
*
54-
* @param {Object} props - Component properties.
54+
* @param {Object} props - Component props.
5555
* @param {Language} props.language - The programming language for which to generate onError handler code.
5656
* @returns {JSX.Element} A Text component containing the onError handler code for the specified language.
5757
*

packages/components/src/components/OnMessage.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ const websocketOnMessageMethod = {
7979
/**
8080
* Renders a WebSocket onMessage event handler for the specified programming language.
8181
*
82-
* @param {Object} props - Component properties.
82+
* @param {Object} props - Component props.
8383
* @param {Language} props.language - The programming language for which to generate onMessage handler code.
8484
* @returns {JSX.Element} A Text component containing the onMessage handler code for the specified language.
8585
*

packages/components/src/components/OnOpen.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ const resolveOpenConfig = (language, framework = '') => {
5252
/**
5353
* Renders a WebSocket onOpen event handler for the specified programming language.
5454
*
55-
* @param {Object} props - Component properties.
55+
* @param {Object} props - Component props.
5656
* @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.

0 commit comments

Comments
 (0)