Skip to content

Commit 788c1ba

Browse files
alandefreitasalandefreitas
committed
feat(generators): tables for symbols have headers
1 parent 86ce271 commit 788c1ba

File tree

239 files changed

+2092
-2575
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

239 files changed

+2092
-2575
lines changed

‎share/mrdocs/addons/generator/adoc/partials/markup/table.adoc.hbs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[{{#if cols}}cols={{cols}}{{/if}}]
1+
[{{#if cols}}cols={{#if (eq cols 2)}}"1,4"{{else}}{{cols}}{{/if}}{{/if}}]
22
|===
33
{{> @partial-block }}
44
|===

‎share/mrdocs/addons/generator/adoc/partials/symbol.adoc.hbs‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@
3131
{{! Base classes }}
3232
{{#if (any_of_by symbol.bases "isPublic")}}
3333
{{#> markup/dynamic-level-h }}Base Classes{{/markup/dynamic-level-h~}}
34-
[cols=2]
34+
[cols="1,4"]
3535
|===
36-
| Name
37-
| Description
36+
|Name|Description
37+
3838
{{#each (filter_by symbol.bases "isPublic")}}
3939
| {{#>markup/code}}{{> type/declarator type }}{{/markup/code}}
4040
| {{> doc/block/inline-brief type.name.symbol.doc.brief }}
@@ -45,10 +45,10 @@
4545
{{! Protected Base classes }}
4646
{{#if (any_of_by symbol.bases "isProtected")}}
4747
{{#> markup/dynamic-level-h }}Protected Base Classes{{/markup/dynamic-level-h~}}
48-
[cols=2]
48+
[cols="1,4"]
4949
|===
50-
| Name
51-
| Description
50+
|Name|Description
51+
5252
{{#each (filter_by symbol.bases "isProtected")}}
5353
| {{#>markup/code}}{{> type/declarator type }}{{/markup/code}}
5454
| {{> doc/block/inline-brief type.name.symbol.doc.brief }}
@@ -74,10 +74,10 @@
7474
{{! Friends }}
7575
{{#if symbol.friends}}
7676
{{#> markup/dynamic-level-h }}Friends{{/markup/dynamic-level-h~}}
77-
[cols=2]
77+
[cols="1,4"]
7878
|===
79-
| Name
80-
| Description
79+
|Name|Description
80+
8181
{{#each symbol.friends }}
8282
{{#if symbol}}
8383
| {{#>markup/code}}{{> symbol/qualified-name symbol }}{{/markup/code}}
@@ -98,7 +98,7 @@
9898
{{! Related symbols }}
9999
{{#if symbol.doc.related}}
100100
{{#> markup/dynamic-level-h }}Non-Member Functions{{/markup/dynamic-level-h~}}
101-
[cols=2]
101+
[cols="1,4"]
102102
|===
103103
| Name
104104
| Description
@@ -112,10 +112,10 @@
112112
{{! Derived classes }}
113113
{{#if symbol.derived}}
114114
{{#> markup/dynamic-level-h }}Derived Classes{{/markup/dynamic-level-h~}}
115-
[cols=2]
115+
[cols="1,4"]
116116
|===
117-
| Name
118-
| Description
117+
|Name|Description
118+
119119
{{#each symbol.derived}}
120120
| {{#if url~}}
121121
{{#>markup/a href=url}}{{#>markup/code}}{{> type/name-info-text . }}{{/markup/code}}{{/markup/a}}
@@ -140,10 +140,10 @@
140140
{{#if symbol.shadows}}
141141
{{#> markup/dynamic-level-h }}Introduced Symbols{{/markup/dynamic-level-h~}}
142142
{{#if (any_of_by symbol.shadows "doc")}}
143-
[cols=2]
143+
[cols="1,4"]
144144
|===
145-
| Name
146-
| Description
145+
|Name|Description
146+
147147
{{#each symbol.shadows}}
148148
| {{> symbol/qualified-name . }}
149149
| {{> doc/block/inline-brief doc.brief }}
@@ -162,7 +162,7 @@
162162
{{! Exceptions }}
163163
{{#if symbol.doc.exceptions}}
164164
{{#> markup/dynamic-level-h }}Exceptions{{/markup/dynamic-level-h~}}
165-
[cols=2]
165+
[cols="1,4"]
166166
|===
167167
| Name
168168
| Thrown on
@@ -190,10 +190,10 @@
190190
{{! Template Parameters }}
191191
{{#if symbol.doc.tparams}}
192192
{{#> markup/dynamic-level-h }}Template Parameters{{/markup/dynamic-level-h~}}
193-
[cols=2]
193+
[cols="1,4"]
194194
|===
195-
| Name
196-
| Description
195+
|Name|Description
196+
197197
{{#each symbol.doc.tparams}}
198198
| *{{name}}*
199199
| {{>doc/block .}}
@@ -204,10 +204,10 @@
204204
{{! Parameters }}
205205
{{#if symbol.doc.params}}
206206
{{#> markup/dynamic-level-h }}Parameters{{/markup/dynamic-level-h~}}
207-
[cols=2]
207+
[cols="1,4"]
208208
|===
209-
| Name
210-
| Description
209+
|Name|Description
210+
211211
{{#each symbol.doc.params}}
212212
| *{{name}}*{{#if direction}} [{{direction}}]{{/if}}
213213
| {{>doc/block .}}

‎share/mrdocs/addons/generator/common/partials/symbol/detail/members-table-impl.hbs‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
{{#>markup/table cols=(select includeBrief 2 1)}}
22
{{#>markup/thead}}
33
{{#>markup/tr~}}
4-
{{#>markup/th}}Name{{/markup/th}}
5-
{{#if includeBrief}}
6-
{{#>markup/th}}Description{{/markup/th}}
7-
{{/if}}
4+
{{#>markup/th}}Name{{/markup/th}}{{#if includeBrief}}{{#>markup/th}}Description{{/markup/th}}{{/if}}
85
{{/markup/tr}}
96
{{/markup/thead}}
107
{{#>markup/tbody}}

‎test-files/golden-tests/config/auto-brief/auto-brief.adoc‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@
66

77
=== Functions
88

9-
[cols=2]
9+
[cols="1,4"]
1010
|===
11-
| Name
12-
| Description
11+
| Name| Description
1312
| link:#copyBriefFromCopyBrief[`copyBriefFromCopyBrief`]
1413
| This is the explicit brief.
1514
| link:#copyBriefFromExplicitBrief[`copyBriefFromExplicitBrief`]

‎test-files/golden-tests/config/auto-brief/auto-brief.html‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ <h2>Functions</h2>
1313
<table style="table-layout: fixed; width: 100%;">
1414
<thead>
1515
<tr>
16-
<th>Name</th>
17-
<th>Description</th>
16+
<th>Name</th><th>Description</th>
1817
</tr>
1918
</thead>
2019
<tbody>

‎test-files/golden-tests/config/auto-brief/no-auto-brief.adoc‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@
66

77
=== Functions
88

9-
[cols=2]
9+
[cols="1,4"]
1010
|===
11-
| Name
12-
| Description
11+
| Name| Description
1312
| link:#copyBriefFromCopyBrief[`copyBriefFromCopyBrief`]
1413
| This is the explicit brief&period;
1514
| link:#copyBriefFromExplicitBrief[`copyBriefFromExplicitBrief`]

‎test-files/golden-tests/config/auto-brief/no-auto-brief.html‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ <h2>Functions</h2>
1313
<table style="table-layout: fixed; width: 100%;">
1414
<thead>
1515
<tr>
16-
<th>Name</th>
17-
<th>Description</th>
16+
<th>Name</th><th>Description</th>
1817
</tr>
1918
</thead>
2019
<tbody>

‎test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.adoc‎

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@
66

77
=== Types
88

9-
[cols=2]
9+
[cols="1,4"]
1010
|===
11-
| Name
12-
| Description
11+
| Name| Description
1312
| link:#A[`A`]
1413
| A helper tag
1514
| link:#X[`X`]
@@ -46,10 +45,9 @@ struct X;
4645

4746
=== Member Functions
4847

49-
[cols=2]
48+
[cols="1,4"]
5049
|===
51-
| Name
52-
| Description
50+
| Name| Description
5351
| link:#X-2constructor-08[`X`] [.small]#[constructor]#
5452
| Constructors
5553
| link:#X-2destructor[`&#126;X`] [.small]#[destructor]#
@@ -164,10 +162,10 @@ X(link:#X[X] const& other) = default;
164162

165163
=== Parameters
166164

167-
[cols=2]
165+
[cols="1,4"]
168166
|===
169-
| Name
170-
| Description
167+
|Name|Description
168+
171169
| *other*
172170
| The object to copy construct from
173171
|===
@@ -189,10 +187,10 @@ X(link:#X[X]&& other) = default;
189187

190188
=== Parameters
191189

192-
[cols=2]
190+
[cols="1,4"]
193191
|===
194-
| Name
195-
| Description
192+
|Name|Description
193+
196194
| *other*
197195
| The object to move construct from
198196
|===
@@ -213,10 +211,10 @@ X(int value);
213211

214212
=== Parameters
215213

216-
[cols=2]
214+
[cols="1,4"]
217215
|===
218-
| Name
219-
| Description
216+
|Name|Description
217+
220218
| *value*
221219
| The value to construct from
222220
|===
@@ -237,10 +235,10 @@ X(link:#A[A] const& value);
237235

238236
=== Parameters
239237

240-
[cols=2]
238+
[cols="1,4"]
241239
|===
242-
| Name
243-
| Description
240+
|Name|Description
241+
244242
| *value*
245243
| The object to copy construct from
246244
|===
@@ -261,10 +259,10 @@ X(link:#A[A]&& value);
261259

262260
=== Parameters
263261

264-
[cols=2]
262+
[cols="1,4"]
265263
|===
266-
| Name
267-
| Description
264+
|Name|Description
265+
268266
| *value*
269267
| The object to move construct from
270268
|===

‎test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.html‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ <h2>Types</h2>
1313
<table style="table-layout: fixed; width: 100%;">
1414
<thead>
1515
<tr>
16-
<th>Name</th>
17-
<th>Description</th>
16+
<th>Name</th><th>Description</th>
1817
</tr>
1918
</thead>
2019
<tbody>
@@ -62,8 +61,7 @@ <h2>Member Functions</h2>
6261
<table style="table-layout: fixed; width: 100%;">
6362
<thead>
6463
<tr>
65-
<th>Name</th>
66-
<th>Description</th>
64+
<th>Name</th><th>Description</th>
6765
</tr>
6866
</thead>
6967
<tbody>

0 commit comments

Comments
 (0)