make jsdoc consistent across all components

Author: batchu5

packages/components/docs/API.md

@@ -51,6 +51,7 @@
   </dd> 
   <dt>
     <a href="#OnClose">OnClose</a>
+      ⇒ <code>JSX.Element</code>
   </dt>
   <dd>
     <p>Component that renders WebSocket onClose event handler for the specified programming language.</p>
@@ -117,7 +118,7 @@ Renders a WebSocket close connection method with optional pre- and post-executio
 | props.language | Language | Programming language used for method formatting. |
 | props.framework | string | Framework used, if any (e.g., &#x27;quarkus&#x27; for Java). |
 | props.methodName | string | Name of the method to generate. |
-| props.methodParams | Array.&lt;string&gt; | List of parameters for the method. |
+| props.methodParams | Array.<string> | List of parameters for the method. |
 | props.preExecutionCode | string | Code to insert before the main function logic. |
 | props.postExecutionCode | string | Code to insert after the main function logic. |
 | props.indent | number | Indentation level for the method block. |
@@ -158,7 +159,7 @@ Component that renders WebSocket connection method for the specified programming
 | Name | Type | Description |
 |------|------|-------------|
 | props | Object | Component properties. |
-| props.language | SupportedLanguage | The programming language for which to generate connection code. |
+| props.language | Language | The programming language for which to generate connection code. |
 | props.title | string | The title of the WebSocket server. |
 
 
@@ -190,7 +191,7 @@ Renders the top-of-file dependency statements for the selected programming langu
 | props.language | Language | The programming language for which to render dependency statements. |
 | props.framework | string | The framework (e.g., &#x27;quarkus&#x27; for Java). |
 | props.role | string | The role (e.g., &#x27;client&#x27;, &#x27;connector&#x27; for Java). |
-| props.additionalDependencies | Array.&lt;string&gt; | Optional additional dependencies to include. |
+| props.additionalDependencies | Array.<string> | Optional additional dependencies to include. |
 
 
 
@@ -270,7 +271,7 @@ Renders a WebSocket message handler method with optional pre- and post-execution
 | props | Object | Component props. |
 | props.language | Language | Programming language used for method formatting. |
 | props.methodName | string | Name of the method to generate. |
-| props.methodParams | Array.&lt;string&gt; | List of parameters for the method. |
+| props.methodParams | Array.<string> | List of parameters for the method. |
 | props.preExecutionCode | string | Code to insert before the main function logic. |
 | props.postExecutionCode | string | Code to insert after the main function logic. |
 | props.customMethodConfig | Object | Optional overrides for default method configuration. |
@@ -316,15 +317,15 @@ Generic Method rendering component.
 | props | Object | Component props. |
 | props.language | Language | Programming language used for method formatting. |
 | props.methodName | string | Name of the method. |
-| props.methodParams | Array.&lt;string&gt; | Method parameters. |
+| props.methodParams | Array.<string> | Method parameters. |
 | props.methodDocs | string | Optional documentation string. |
 | props.methodLogic | string | Core method logic. |
 | props.preExecutionCode | string | Code before main logic. |
 | props.postExecutionCode | string | Code after main logic. |
 | props.indent | number | Indentation for the method block. |
 | props.newLines | number | Number of new lines after method. |
 | props.customMethodConfig | Object | Optional custom syntax configuration for the current language. |
-| 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. |
+| 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. |
 | props.framework | string | Framework name for nested configurations (e.g., &#x27;quarkus&#x27; for Java). |
 
 
@@ -336,10 +337,10 @@ Generic Method rendering component.
 const language = "java"
 const methodName = "registerHandler"
 const methodParams = ["self", "handler"]
-const methodDocs = "# Process the input data."
-const methodLogic = "pass"
-const preExecutionCode = "# Before handler registration"
-const postExecutionCode = "# After handler registration"
+const methodDocs = "// Process the input data."
+const methodLogic = "// TODO: implement"
+const preExecutionCode = "// Before handler registration"
+const postExecutionCode = "// After handler registration"
 const customMethodConfig={ openingTag: "{", closingTag: "}", indentSize: 6 }
 const methodConfig = {"java" : {methodDocs : methodDocs, methodLogic: methodLogic }}
 const framework = "quarkus"
@@ -407,12 +408,17 @@ Component that renders WebSocket onClose event handler for the specified program
 | Name | Type | Description |
 |------|------|-------------|
 | props | Object | Component properties. |
-| props.language | SupportedLanguage | The programming language for which to generate onClose handler code. |
+| props.language | Language | The programming language for which to generate onClose handler code. |
 | props.framework | string | Optional framework variant (e.g., &#x27;quarkus&#x27; for java). |
 | props.title | string | The title of the WebSocket server. |
 
 
 
+### Returns
+
+- **JSX.Element** - A Text component containing the onClose handler code for the specified language.
+
+
 
 ### Example
 
@@ -438,15 +444,15 @@ Component that renders WebSocket onError event handler for the specified program
 | Name | Type | Description |
 |------|------|-------------|
 | props | Object | Component properties. |
-| props.language | SupportedLanguage | The programming language for which to generate onError handler code. |
+| props.language | Language | The programming language for which to generate onError handler code. |
 
 
 
 
 ### Example
 
 ```js
-const language = "java"
+const language = "javascript"
 return (
   <OnError language={language} />
 )
@@ -464,15 +470,15 @@ Component that renders WebSocket onMessage event handler for the specified progr
 | Name | Type | Description |
 |------|------|-------------|
 | props | Object | Component properties. |
-| props.language | SupportedLanguage | The programming language for which to generate onMessage handler code. |
+| props.language | Language | The programming language for which to generate onMessage handler code. |
 
 
 
 
 ### Example
 
 ```js
-const language = "java"
+const language = "javascript"
 return (
   <OnMessage language={language} />
 )
@@ -490,7 +496,7 @@ Component that renders WebSocket onOpen event handler for the specified programm
 | Name | Type | Description |
 |------|------|-------------|
 | props | Object | Component properties. |
-| props.language | SupportedLanguage | The programming language for which to generate onOpen handler code. |
+| props.language | Language | The programming language for which to generate onOpen handler code. |
 | props.framework | string | Optional framework variant (e.g., &#x27;quarkus&#x27; for java). |
 | props.title | string | The title of the WebSocket server. |
 
@@ -521,9 +527,9 @@ Component for rendering query parameter variables code.
 | Name | Type | Description |
 |------|------|-------------|
 | props | Object | Component props. |
-| props.language | SupportedLanguage | The target programming language. |
+| props.language | Language | The target programming language. |
 | props.framework | string | Optional framework for the language. |
-| props.queryParams | Array.&lt;Array.&lt;string&gt;&gt; | Array of query parameters, each represented as [paramName, paramType?]. |
+| props.queryParams | Array.<Array.<string>> | Array of query parameters, each represented as [paramName, paramType?]. |
 
 
 
@@ -573,7 +579,7 @@ Renders a WebSocket error handler registration method with optional pre- and pos
 | props | Object | Component props. |
 | props.language | Language | Programming language used for method formatting. |
 | props.methodName | string | Name of the method to generate. |
-| props.methodParams | Array.&lt;string&gt; | List of parameters for the method. |
+| props.methodParams | Array.<string> | List of parameters for the method. |
 | props.preExecutionCode | string | Code to insert before the main function logic. |
 | props.postExecutionCode | string | Code to insert after the main function logic. |
 | props.customMethodConfig | Object | Optional overrides for default method configuration. |
@@ -615,7 +621,7 @@ Renders a WebSocket message handler registration method with optional pre- and p
 | props | Object | Component props. |
 | props.language | Language | Programming language used for method formatting. |
 | props.methodName | string | Name of the method to generate. |
-| props.methodParams | Array.&lt;string&gt; | List of parameters for the method. |
+| props.methodParams | Array.<string> | List of parameters for the method. |
 | props.preExecutionCode | string | Code to insert before the main function logic. |
 | props.postExecutionCode | string | Code to insert after the main function logic. |
 
@@ -654,8 +660,8 @@ Generates both static and instance methods for sending messages through WebSocke
 | Name | Type | Description |
 |------|------|-------------|
 | props | Object | Component props. |
-| props.language | SupportedLanguage | The target programming language. |
-| props.sendOperations | Array.&lt;Object&gt; | Array of send operations from AsyncAPI document. |
+| props.language | Language | The target programming language. |
+| props.sendOperations | Array.<Object> | Array of send operations from AsyncAPI document. |
 | props.clientName | string | The name of the client class. |
 
 

packages/components/jsdoc2md-handlebars/api.hbs

@@ -28,7 +28,7 @@
 | Name | Type | Description |
 |------|------|-------------|
 {{#each params}}
-| {{name}} | {{escapeType type.names.[0]}} | {{description}} |
+| {{name}} | {{{escapeType type.names.[0]}}} | {{description}} |
 {{/each}}
 
 {{/if}}

packages/components/src/components/Connect.js

@@ -5,14 +5,14 @@ import { OnError } from './OnError';
 import { OnClose } from './OnClose';
 
 /**
- * @typedef {'python' | 'javascript' | 'dart'} SupportedLanguage
+ * @typedef {'python' | 'javascript' | 'dart'} Language
  * Supported programming languages for WebSocket connection method generation.
  */
 
 /**
  * Mapping of supported programming languages to their WebSocket connection method implementations.
  * 
- * @type {Object.<SupportedLanguage, Function>}
+ * @type {Object.<Language, Function>}
  */
 const websocketConnectMethod = {
   javascript: (onOpenMethod, onMessageMethod, onErrorMethod, onCloseMethod) => {
@@ -95,7 +95,7 @@ Future<void> connect() async {
  * Component that renders WebSocket connection method for the specified programming language.
  * 
  * @param {Object} props - Component properties.
- * @param {SupportedLanguage} props.language - The programming language for which to generate connection code.
+ * @param {Language} props.language - The programming language for which to generate connection code.
  * @param {string} props.title - The title of the WebSocket server.
  * 
  * @example

packages/components/src/components/MethodGenerator.js

@@ -71,18 +71,18 @@ const buildIndentedLogic = (logic, preExecutionCode, postExecutionCode, indentSi
  * @param {string} [props.postExecutionCode=''] - Code after main logic.
  * @param {number} [props.indent=2] - Indentation for the method block.
  * @param {number} [props.newLines=1] - Number of new lines after method.
- * @param {{ returnType: string, openingTag: string, closingTag: string, indentSize: number, parameterWrap: boolean }} [props.customMethodConfig]  - Optional custom syntax configuration for the current language.
- * @param {Record<Language, { methodDocs: string, methodLogic: string } | Record<string, { methodDocs: string, methodLogic: string }>>} [props.methodConfig] - Language-level or framework-level configuration.
+ * @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.
+ * @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.
  * @param {string} [props.framework] - Framework name for nested configurations (e.g., 'quarkus' for Java).
  * 
  * @example
  * const language = "java"
  * const methodName = "registerHandler"
  * const methodParams = ["self", "handler"]
- * const methodDocs = "# Process the input data."
- * const methodLogic = "pass"
- * const preExecutionCode = "# Before handler registration"
- * const postExecutionCode = "# After handler registration"
+ * const methodDocs = "// Process the input data."
+ * const methodLogic = "// TODO: implement"
+ * const preExecutionCode = "// Before handler registration"
+ * const postExecutionCode = "// After handler registration"
  * const customMethodConfig={ openingTag: "{", closingTag: "}", indentSize: 6 }
  * const methodConfig = {"java" : {methodDocs : methodDocs, methodLogic: methodLogic }}
  * const framework = "quarkus"

packages/components/src/components/Models.js

@@ -20,13 +20,13 @@ import {
  */
 
 /**
- * @typedef {PythonGenerator | JavaGenerator | TypeScriptGenerator | CSharpGenerator | RustGenerator | JavaScriptGenerator} ModelinaGeneratorClass
- * Represents any Modelina generator instance.
+ * @typedef {PythonGenerator | JavaGenerator | TypeScriptGenerator | CSharpGenerator | RustGenerator | JavaScriptGenerator} ModelinaGeneratorConstructor
+ * Represents any Modelina generator constructor.
  */
 
 /**
  * Mapping of language strings to Modelina generator classes and file extensions.
- * @type {Record<string, { generator: ModelinaGeneratorClass, extension: string }>}
+ * @type {Record<string, { generator: ModelinaGeneratorConstructor, extension: string }>}
  */
 const generatorConfig = {
   python: { generator: PythonGenerator, extension: 'py' },

packages/components/src/components/OnClose.js

@@ -1,14 +1,14 @@
 import { Text } from '@asyncapi/generator-react-sdk';
 
 /**
- * @typedef {'python' | 'javascript' | 'dart' | 'java' } SupportedLanguage
+ * @typedef {'python' | 'javascript' | 'dart' | 'java' } Language
  * Supported programming languages for WebSocket onClose handler generation.
  */
 
 /**
  * Mapping of supported programming languages to their WebSocket onClose event handler implementations.
  * 
- * @type {Object.<SupportedLanguage, Function>}
+ * @type {Object.<Language, Function>}
  */
 const websocketOnCloseMethod = {
   javascript: (title) => {
@@ -61,10 +61,12 @@ const resolveCloseConfig = (language, framework = '') => {
  * Component that renders WebSocket onClose event handler for the specified programming language.
  * 
  * @param {Object} props - Component properties.
- * @param {SupportedLanguage} props.language - The programming language for which to generate onClose handler code.
+ * @param {Language} props.language - The programming language for which to generate onClose handler code.
  * @param {string} [props.framework=''] - Optional framework variant (e.g., 'quarkus' for java).
  * @param {string} props.title - The title of the WebSocket server.
  * 
+ * @returns {JSX.Element} A Text component containing the onClose handler code for the specified language.
+ * 
  * @example
  * const language = "java"
  * const framework = "quarkus"

packages/components/src/components/OnError.js

@@ -1,14 +1,14 @@
 import { Text } from '@asyncapi/generator-react-sdk';
 
 /**
- * @typedef {'python' | 'javascript' | 'dart'} SupportedLanguage
+ * @typedef {'python' | 'javascript' | 'dart'} Language
  * Supported programming languages for WebSocket onError handler generation.
  */
 
 /**
  * Mapping of supported programming languages to their WebSocket onError event handler implementations.
  * 
- * @type {Object.<SupportedLanguage, Function>}
+ * @type {Object.<Language, Function>}
  */
 const websocketOnErrorMethod = {
   javascript: () => {
@@ -52,10 +52,10 @@ const websocketOnErrorMethod = {
  * Component that renders WebSocket onError event handler for the specified programming language.
  * 
  * @param {Object} props - Component properties.
- * @param {SupportedLanguage} props.language - The programming language for which to generate onError handler code.
+ * @param {Language} props.language - The programming language for which to generate onError handler code.
  * 
  * @example
- * const language = "java"
+ * const language = "javascript"
  * return (
  *   <OnError language={language} />
  * )

packages/components/src/components/OnMessage.js

@@ -1,14 +1,14 @@
 import { Text } from '@asyncapi/generator-react-sdk';
 
 /**
- * @typedef {'python' | 'javascript' | 'dart'} SupportedLanguage
+ * @typedef {'python' | 'javascript' | 'dart'} Language
  * Supported programming languages for WebSocket onMessage handler generation.
  */
 
 /**
  * Mapping of supported programming languages to their WebSocket onMessage event handler implementations.
  * 
- * @type {Object.<SupportedLanguage, Function>}
+ * @type {Object.<Language, Function>}
  */
 const websocketOnMessageMethod = {
   javascript: () => {
@@ -80,10 +80,10 @@ const websocketOnMessageMethod = {
  * Component that renders WebSocket onMessage event handler for the specified programming language.
  * 
  * @param {Object} props - Component properties.
- * @param {SupportedLanguage} props.language - The programming language for which to generate onMessage handler code.
+ * @param {Language} props.language - The programming language for which to generate onMessage handler code.
  * 
  * @example
- * const language = "java"
+ * const language = "javascript"
  * return (
  *   <OnMessage language={language} />
  * )

packages/components/src/components/OnOpen.js

@@ -1,14 +1,14 @@
 import { Text } from '@asyncapi/generator-react-sdk';
 
 /**
- * @typedef {'python' | 'javascript' | 'java'} SupportedLanguage
+ * @typedef {'python' | 'javascript' | 'java'} Language
  * Supported programming languages for WebSocket onOpen handler generation.
  */
 
 /**
  * Mapping of supported programming languages to their WebSocket onOpen event handler implementations.
  * 
- * @type {Object.<SupportedLanguage, Function>}
+ * @type {Object.<Language, Function>}
  */
 const websocketOnOpenMethod = {
   javascript: (title) => {
@@ -53,7 +53,7 @@ const resolveOpenConfig = (language, framework = '') => {
  * Component that renders WebSocket onOpen event handler for the specified programming language.
  * 
  * @param {Object} props - Component properties.
- * @param {SupportedLanguage} props.language - The programming language for which to generate onOpen handler code.
+ * @param {Language} props.language - The programming language for which to generate onOpen handler code.
  * @param {string} [props.framework=''] - Optional framework variant (e.g., 'quarkus' for java).
  * @param {string} props.title - The title of the WebSocket server.
  *