Skip to content

Commit a66ab27

Browse files
batchu5batchu5
committed
refactor api.hbs to highlight <dt> tag
1 parent bbb9877 commit a66ab27

File tree

3 files changed

+30
-100
lines changed

3 files changed

+30
-100
lines changed

‎apps/generator/docs/api_components.md‎

Lines changed: 23 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -6,173 +6,116 @@ weight: 77
66
## Components
77

88
<dl>
9-
<dt>
10-
<a href="#CloseConnection">CloseConnection</a>
11-
⇒ <code>JSX.Element</code>
12-
</dt>
9+
<dt><a href="#CloseConnection">CloseConnection</a> ⇒ <code>JSX.Element</code></dt>
1310
<dd>
1411

1512
Renders a WebSocket close connection method with optional pre- and post-execution logic.
1613

1714
</dd>
18-
<dt>
19-
<a href="#Connect">Connect</a>
20-
⇒ <code>JSX.Element</code>
21-
</dt>
15+
<dt><a href="#Connect">Connect</a> ⇒ <code>JSX.Element</code></dt>
2216
<dd>
2317

2418
Renders a WebSocket connection method for the specified programming language.
2519

2620
</dd>
27-
<dt>
28-
<a href="#DependencyProvider">DependencyProvider</a>
29-
⇒ <code>JSX.Element</code>
30-
</dt>
21+
<dt><a href="#DependencyProvider">DependencyProvider</a> ⇒ <code>JSX.Element</code></dt>
3122
<dd>
3223

3324
Renders the top-of-file dependency statements for the selected programming language.
3425

3526
</dd>
36-
<dt>
37-
<a href="#FileHeaderInfo">FileHeaderInfo</a>
38-
⇒ <code>JSX.Element</code>
39-
</dt>
27+
<dt><a href="#FileHeaderInfo">FileHeaderInfo</a> ⇒ <code>JSX.Element</code></dt>
4028
<dd>
4129

4230
Renders a file header with metadata information such as title, version, protocol, host, and path.
4331

4432
</dd>
45-
<dt>
46-
<a href="#HandleMessage">HandleMessage</a>
47-
⇒ <code>JSX.Element</code>
48-
</dt>
33+
<dt><a href="#HandleMessage">HandleMessage</a> ⇒ <code>JSX.Element</code></dt>
4934
<dd>
5035

5136
Renders a WebSocket message handler method with optional pre- and post-execution logic.
5237

5338
</dd>
54-
<dt>
55-
<a href="#MethodGenerator">MethodGenerator</a>
56-
⇒ <code>JSX.Element</code>
57-
</dt>
39+
<dt><a href="#MethodGenerator">MethodGenerator</a> ⇒ <code>JSX.Element</code></dt>
5840
<dd>
5941

6042
Renders a language-specific formatted method definition.
6143

6244
</dd>
63-
<dt>
64-
<a href="#Models">Models</a>
65-
⇒ <code>Array.&lt;File&gt;</code>
66-
</dt>
45+
<dt><a href="#Models">Models</a> ⇒ <code>Array.&lt;File&gt;</code></dt>
6746
<dd>
6847

6948
Renders an array of model files based on the AsyncAPI document.
7049

7150
</dd>
72-
<dt>
73-
<a href="#OnClose">OnClose</a>
74-
⇒ <code>JSX.Element</code>
75-
</dt>
51+
<dt><a href="#OnClose">OnClose</a> ⇒ <code>JSX.Element</code></dt>
7652
<dd>
7753

7854
Renders a WebSocket onClose event handler for the specified programming language.
7955

8056
</dd>
81-
<dt>
82-
<a href="#OnError">OnError</a>
83-
⇒ <code>JSX.Element</code>
84-
</dt>
57+
<dt><a href="#OnError">OnError</a> ⇒ <code>JSX.Element</code></dt>
8558
<dd>
8659

8760
Renders a WebSocket onError event handler for the specified programming language.
8861

8962
</dd>
90-
<dt>
91-
<a href="#OnMessage">OnMessage</a>
92-
⇒ <code>JSX.Element</code>
93-
</dt>
63+
<dt><a href="#OnMessage">OnMessage</a> ⇒ <code>JSX.Element</code></dt>
9464
<dd>
9565

9666
Renders a WebSocket onMessage event handler for the specified programming language.
9767

9868
</dd>
99-
<dt>
100-
<a href="#OnOpen">OnOpen</a>
101-
⇒ <code>JSX.Element</code>
102-
</dt>
69+
<dt><a href="#OnOpen">OnOpen</a> ⇒ <code>JSX.Element</code></dt>
10370
<dd>
10471

10572
Renders a WebSocket onOpen event handler for the specified programming language.
10673

10774
</dd>
108-
<dt>
109-
<a href="#QueryParamsVariables">QueryParamsVariables</a>
110-
⇒ <code>Array.&lt;JSX.Element&gt;</code>
111-
</dt>
75+
<dt><a href="#QueryParamsVariables">QueryParamsVariables</a> ⇒ <code>Array.&lt;JSX.Element&gt;</code></dt>
11276
<dd>
11377

11478
Renders query parameter variables code blocks.
11579

11680
</dd>
117-
<dt>
118-
<a href="#AvailableOperations">AvailableOperations</a>
119-
⇒ <code>JSX.Element</code>
120-
</dt>
81+
<dt><a href="#AvailableOperations">AvailableOperations</a> ⇒ <code>JSX.Element</code></dt>
12182
<dd>
12283

12384
Renders a list of AsyncAPI operations with their headers and message examples.
12485

12586
</dd>
126-
<dt>
127-
<a href="#CoreMethods">CoreMethods</a>
128-
⇒ <code>JSX.Element</code>
129-
</dt>
87+
<dt><a href="#CoreMethods">CoreMethods</a> ⇒ <code>JSX.Element</code></dt>
13088
<dd>
13189

13290
Renders a list of core WebSocket client methods for a given target language.
13391

13492
</dd>
135-
<dt>
136-
<a href="#Installation">Installation</a>
137-
⇒ <code>JSX.Element</code>
138-
</dt>
93+
<dt><a href="#Installation">Installation</a> ⇒ <code>JSX.Element</code></dt>
13994
<dd>
14095

14196
Renders the Installation Command for a given language.
14297

14398
</dd>
144-
<dt>
145-
<a href="#MessageExamples">MessageExamples</a>
146-
⇒ <code>JSX.Element</code>
147-
</dt>
99+
<dt><a href="#MessageExamples">MessageExamples</a> ⇒ <code>JSX.Element</code></dt>
148100
<dd>
149101

150102
Renders Message Examples of a given AsyncAPI operation.
151103

152104
</dd>
153-
<dt>
154-
<a href="#OperationHeader">OperationHeader</a>
155-
⇒ <code>JSX.Element</code>
156-
</dt>
105+
<dt><a href="#OperationHeader">OperationHeader</a> ⇒ <code>JSX.Element</code></dt>
157106
<dd>
158107

159108
Renders a header section for a single AsyncAPI operation.
160109

161110
</dd>
162-
<dt>
163-
<a href="#Overview">Overview</a>
164-
⇒ <code>JSX.Element</code>
165-
</dt>
111+
<dt><a href="#Overview">Overview</a> ⇒ <code>JSX.Element</code></dt>
166112
<dd>
167113

168114
Renders an overview section for a WebSocket client.
169115
Displays the API description, version, and server URL.
170116

171117
</dd>
172-
<dt>
173-
<a href="#Readme">Readme</a>
174-
⇒ <code>JSX.Element</code>
175-
</dt>
118+
<dt><a href="#Readme">Readme</a> ⇒ <code>JSX.Element</code></dt>
176119
<dd>
177120

178121
Renders a README.md file for a given AsyncAPI document.
@@ -182,37 +125,25 @@ and available operations) into a single File component based on the
182125
provided AsyncAPI document, generator parameters, and target language.
183126

184127
</dd>
185-
<dt>
186-
<a href="#Usage">Usage</a>
187-
⇒ <code>JSX.Element</code>
188-
</dt>
128+
<dt><a href="#Usage">Usage</a> ⇒ <code>JSX.Element</code></dt>
189129
<dd>
190130

191131
Renders a usage example snippet for a generated WebSocket client in a given language.
192132

193133
</dd>
194-
<dt>
195-
<a href="#RegisterErrorHandler">RegisterErrorHandler</a>
196-
⇒ <code>JSX.Element</code>
197-
</dt>
134+
<dt><a href="#RegisterErrorHandler">RegisterErrorHandler</a> ⇒ <code>JSX.Element</code></dt>
198135
<dd>
199136

200137
Renders a WebSocket error handler registration method with optional pre- and post-execution logic.
201138

202139
</dd>
203-
<dt>
204-
<a href="#RegisterMessageHandler">RegisterMessageHandler</a>
205-
⇒ <code>JSX.Element</code>
206-
</dt>
140+
<dt><a href="#RegisterMessageHandler">RegisterMessageHandler</a> ⇒ <code>JSX.Element</code></dt>
207141
<dd>
208142

209143
Renders a WebSocket message handler registration method with optional pre- and post-execution logic.
210144

211145
</dd>
212-
<dt>
213-
<a href="#SendOperations">SendOperations</a>
214-
⇒ <code>Array.&lt;JSX.Element&gt;</code>
215-
</dt>
146+
<dt><a href="#SendOperations">SendOperations</a> ⇒ <code>Array.&lt;JSX.Element&gt;</code></dt>
216147
<dd>
217148

218149
Renders WebSocket send operation methods.

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

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,7 @@ weight: 77
88
<dl>
99
{{#functions}}
1010
{{#unless (eq name "ownKeys")}}
11-
<dt>
12-
<a href="#{{name}}">{{name}}</a>
13-
{{#if returns.length}}
14-
⇒ <code>{{{escapeType returns.[0].type.names.[0]}}}</code>
15-
{{/if}}
16-
</dt>
11+
<dt><a href="#{{name}}">{{name}}</a>{{#if returns.length}} ⇒ <code>{{{escapeType returns.[0].type.names.[0]}}}</code>{{/if}}</dt>
1712
<dd>
1813

1914
{{{description}}}

‎packages/components/jsdoc2md-helpers/jsdoc-helper.js‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
module.exports = {
22
/**
3-
* Escapes pipe characters in a JSDoc type string for Markdown output.
3+
* Escapes HTML and Markdown-sensitive characters in a JSDoc type string for Markdown output.
44
* @param {string|null|undefined} type - Raw JSDoc type string.
55
* @returns {string|null|undefined} Escaped string or original falsy value.
66
*/
@@ -17,7 +17,11 @@ module.exports = {
1717
},
1818
/**
1919
* Equality helper for Handlebars templates
20-
*/
20+
* Strict equality helper for Handlebars templates.
21+
* @param {*} a - First value to compare.
22+
* @param {*} b - Second value to compare.
23+
* @returns {boolean} True if a === b.
24+
*/
2125
eq(a, b) {
2226
return a === b;
2327
},

0 commit comments

Comments
 (0)