Skip to content

Commit 82157fe

Browse files
committed
add indentation
1 parent 2d03374 commit 82157fe

File tree

2 files changed

+48
-48
lines changed

2 files changed

+48
-48
lines changed

apps/generator/docs/api_components.md

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -5,97 +5,97 @@ weight: 77
55

66
## Components
77

8-
* [CloseConnection](#CloseConnection)`JSX.Element`
9-
8+
* [CloseConnection](#CloseConnection)`JSX.Element`<br/>
9+
1010
Renders a WebSocket close connection method with optional pre- and post-execution logic.
1111

12-
* [Connect](#Connect)`JSX.Element`
13-
12+
* [Connect](#Connect)`JSX.Element`<br/>
13+
1414
Renders a WebSocket connection method for the specified programming language.
1515

16-
* [DependencyProvider](#DependencyProvider)`JSX.Element`
17-
16+
* [DependencyProvider](#DependencyProvider)`JSX.Element`<br/>
17+
1818
Renders the top-of-file dependency statements for the selected programming language.
1919

20-
* [FileHeaderInfo](#FileHeaderInfo)`JSX.Element`
21-
20+
* [FileHeaderInfo](#FileHeaderInfo)`JSX.Element`<br/>
21+
2222
Renders a file header with metadata information such as title, version, protocol, host, and path.
2323

24-
* [HandleMessage](#HandleMessage)`JSX.Element`
25-
24+
* [HandleMessage](#HandleMessage)`JSX.Element`<br/>
25+
2626
Renders a WebSocket message handler method with optional pre- and post-execution logic.
2727

28-
* [MethodGenerator](#MethodGenerator)`JSX.Element`
29-
28+
* [MethodGenerator](#MethodGenerator)`JSX.Element`<br/>
29+
3030
Renders a language-specific formatted method definition.
3131

32-
* [Models](#Models)`Array.&lt;File&gt;`
33-
32+
* [Models](#Models)`Array.&lt;File&gt;`<br/>
33+
3434
Renders an array of model files based on the AsyncAPI document.
3535

36-
* [OnClose](#OnClose)`JSX.Element`
37-
36+
* [OnClose](#OnClose)`JSX.Element`<br/>
37+
3838
Renders a WebSocket onClose event handler for the specified programming language.
3939

40-
* [OnError](#OnError)`JSX.Element`
41-
40+
* [OnError](#OnError)`JSX.Element`<br/>
41+
4242
Renders a WebSocket onError event handler for the specified programming language.
4343

44-
* [OnMessage](#OnMessage)`JSX.Element`
45-
44+
* [OnMessage](#OnMessage)`JSX.Element`<br/>
45+
4646
Renders a WebSocket onMessage event handler for the specified programming language.
4747

48-
* [OnOpen](#OnOpen)`JSX.Element`
49-
48+
* [OnOpen](#OnOpen)`JSX.Element`<br/>
49+
5050
Renders a WebSocket onOpen event handler for the specified programming language.
5151

52-
* [QueryParamsVariables](#QueryParamsVariables)`Array.&lt;JSX.Element&gt;`
53-
52+
* [QueryParamsVariables](#QueryParamsVariables)`Array.&lt;JSX.Element&gt;`<br/>
53+
5454
Renders query parameter variables code blocks.
5555

56-
* [AvailableOperations](#AvailableOperations)`JSX.Element`
57-
56+
* [AvailableOperations](#AvailableOperations)`JSX.Element`<br/>
57+
5858
Renders a list of AsyncAPI operations with their headers and message examples.
5959

60-
* [CoreMethods](#CoreMethods)`JSX.Element`
61-
60+
* [CoreMethods](#CoreMethods)`JSX.Element`<br/>
61+
6262
Renders a list of core WebSocket client methods for a given target language.
6363

64-
* [Installation](#Installation)`JSX.Element`
65-
64+
* [Installation](#Installation)`JSX.Element`<br/>
65+
6666
Renders the Installation Command for a given language.
6767

68-
* [MessageExamples](#MessageExamples)`JSX.Element`
69-
68+
* [MessageExamples](#MessageExamples)`JSX.Element`<br/>
69+
7070
Renders Message Examples of a given AsyncAPI operation.
7171

72-
* [OperationHeader](#OperationHeader)`JSX.Element`
73-
72+
* [OperationHeader](#OperationHeader)`JSX.Element`<br/>
73+
7474
Renders a header section for a single AsyncAPI operation.
7575

76-
* [Overview](#Overview)`JSX.Element`
77-
76+
* [Overview](#Overview)`JSX.Element`<br/>
77+
7878
Renders an overview section for a WebSocket client.
7979
Displays the API description, version, and server URL.
8080

81-
* [Readme](#Readme)`JSX.Element`
82-
81+
* [Readme](#Readme)`JSX.Element`<br/>
82+
8383
Renders a README.md file for a given AsyncAPI document. Composes multiple sections (overview, installation, usage, core methods, and available operations) into a single File component based on the provided AsyncAPI document, generator parameters, and target language.
8484

85-
* [Usage](#Usage)`JSX.Element`
86-
85+
* [Usage](#Usage)`JSX.Element`<br/>
86+
8787
Renders a usage example snippet for a generated WebSocket client in a given language.
8888

89-
* [RegisterErrorHandler](#RegisterErrorHandler)`JSX.Element`
90-
89+
* [RegisterErrorHandler](#RegisterErrorHandler)`JSX.Element`<br/>
90+
9191
Renders a WebSocket error handler registration method with optional pre- and post-execution logic.
9292

93-
* [RegisterMessageHandler](#RegisterMessageHandler)`JSX.Element`
94-
93+
* [RegisterMessageHandler](#RegisterMessageHandler)`JSX.Element`<br/>
94+
9595
Renders a WebSocket message handler registration method with optional pre- and post-execution logic.
9696

97-
* [SendOperations](#SendOperations)`Array.&lt;JSX.Element&gt;`
98-
97+
* [SendOperations](#SendOperations)`Array.&lt;JSX.Element&gt;`<br/>
98+
9999
Renders WebSocket send operation methods.
100100
Generates both static and instance methods for sending messages through WebSocket connections.
101101

packages/components/jsdoc2md-handlebars/api.hbs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ weight: 77
77

88
{{#functions}}
99
{{#unless (eq name "ownKeys")}}
10-
* [{{name}}](#{{name}}){{#if returns.length}} ⇒ `{{{escapeType returns.[0].type.names.[0]}}}`{{/if}}
11-
10+
* [{{name}}](#{{name}}){{#if returns.length}} ⇒ `{{{escapeType returns.[0].type.names.[0]}}}`{{/if}}<br/>
11+
1212
{{{description}}}
1313

1414
{{/unless}}

0 commit comments

Comments
 (0)