Skip to content

feat(generators): tables for symbols have headers #1104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 1, 2025
Merged

feat(generators): tables for symbols have headers #1104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/adoc/partials/markup/table.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[{{#if cols}}cols={{cols}}{{/if}}]
[{{#if cols}}cols={{#if (eq cols 2)}}"1,4"{{else}}{{cols}}{{/if}}{{/if}}]
|===
{{> @partial-block }}
|===
46 changes: 23 additions & 23 deletions share/mrdocs/addons/generator/adoc/partials/symbol.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@
{{! Base classes }}
{{#if (any_of_by symbol.bases "isPublic")}}
{{#> markup/dynamic-level-h }}Base Classes{{/markup/dynamic-level-h~}}
[cols=2]
[cols="1,4"]
|===
| Name
| Description
|Name|Description

{{#each (filter_by symbol.bases "isPublic")}}
| {{#>markup/code}}{{> type/declarator type }}{{/markup/code}}
| {{> doc/block/inline-brief type.name.symbol.doc.brief }}
Expand All @@ -45,10 +45,10 @@
{{! Protected Base classes }}
{{#if (any_of_by symbol.bases "isProtected")}}
{{#> markup/dynamic-level-h }}Protected Base Classes{{/markup/dynamic-level-h~}}
[cols=2]
[cols="1,4"]
|===
| Name
| Description
|Name|Description

{{#each (filter_by symbol.bases "isProtected")}}
| {{#>markup/code}}{{> type/declarator type }}{{/markup/code}}
| {{> doc/block/inline-brief type.name.symbol.doc.brief }}
Expand All @@ -74,10 +74,10 @@
{{! Friends }}
{{#if symbol.friends}}
{{#> markup/dynamic-level-h }}Friends{{/markup/dynamic-level-h~}}
[cols=2]
[cols="1,4"]
|===
| Name
| Description
|Name|Description

{{#each symbol.friends }}
{{#if symbol}}
| {{#>markup/code}}{{> symbol/qualified-name symbol }}{{/markup/code}}
Expand All @@ -98,7 +98,7 @@
{{! Related symbols }}
{{#if symbol.doc.related}}
{{#> markup/dynamic-level-h }}Non-Member Functions{{/markup/dynamic-level-h~}}
[cols=2]
[cols="1,4"]
|===
| Name
| Description
Expand All @@ -112,10 +112,10 @@
{{! Derived classes }}
{{#if symbol.derived}}
{{#> markup/dynamic-level-h }}Derived Classes{{/markup/dynamic-level-h~}}
[cols=2]
[cols="1,4"]
|===
| Name
| Description
|Name|Description

{{#each symbol.derived}}
| {{#if url~}}
{{#>markup/a href=url}}{{#>markup/code}}{{> type/name-info-text . }}{{/markup/code}}{{/markup/a}}
Expand All @@ -140,10 +140,10 @@
{{#if symbol.shadows}}
{{#> markup/dynamic-level-h }}Introduced Symbols{{/markup/dynamic-level-h~}}
{{#if (any_of_by symbol.shadows "doc")}}
[cols=2]
[cols="1,4"]
|===
| Name
| Description
|Name|Description

{{#each symbol.shadows}}
| {{> symbol/qualified-name . }}
| {{> doc/block/inline-brief doc.brief }}
Expand All @@ -162,7 +162,7 @@
{{! Exceptions }}
{{#if symbol.doc.exceptions}}
{{#> markup/dynamic-level-h }}Exceptions{{/markup/dynamic-level-h~}}
[cols=2]
[cols="1,4"]
|===
| Name
| Thrown on
Expand Down Expand Up @@ -190,10 +190,10 @@
{{! Template Parameters }}
{{#if symbol.doc.tparams}}
{{#> markup/dynamic-level-h }}Template Parameters{{/markup/dynamic-level-h~}}
[cols=2]
[cols="1,4"]
|===
| Name
| Description
|Name|Description

{{#each symbol.doc.tparams}}
| *{{name}}*
| {{>doc/block .}}
Expand All @@ -204,10 +204,10 @@
{{! Parameters }}
{{#if symbol.doc.params}}
{{#> markup/dynamic-level-h }}Parameters{{/markup/dynamic-level-h~}}
[cols=2]
[cols="1,4"]
|===
| Name
| Description
|Name|Description

{{#each symbol.doc.params}}
| *{{name}}*{{#if direction}} [{{direction}}]{{/if}}
| {{>doc/block .}}
Expand Down
5 changes: 1 addition & 4 deletions share/mrdocs/addons/generator/common/partials/symbol/detail/members-table-impl.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
{{#>markup/table cols=(select includeBrief 2 1)}}
{{#>markup/thead}}
{{#>markup/tr~}}
{{#>markup/th}}Name{{/markup/th}}
{{#if includeBrief}}
{{#>markup/th}}Description{{/markup/th}}
{{/if}}
{{#>markup/th}}Name{{/markup/th}}{{#if includeBrief}}{{#>markup/th}}Description{{/markup/th}}{{/if}}
{{/markup/tr}}
{{/markup/thead}}
{{#>markup/tbody}}
Expand Down
5 changes: 2 additions & 3 deletions test-files/golden-tests/config/auto-brief/auto-brief.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@

=== Functions

[cols=2]
[cols="1,4"]
|===
| Name
| Description
| Name| Description
| link:#copyBriefFromCopyBrief[`copyBriefFromCopyBrief`]
| This is the explicit brief.
| link:#copyBriefFromExplicitBrief[`copyBriefFromExplicitBrief`]
Expand Down
3 changes: 1 addition & 2 deletions test-files/golden-tests/config/auto-brief/auto-brief.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ <h2>Functions</h2>
<table style="table-layout: fixed; width: 100%;">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Name</th><th>Description</th>
</tr>
</thead>
<tbody>
Expand Down
5 changes: 2 additions & 3 deletions test-files/golden-tests/config/auto-brief/no-auto-brief.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@

=== Functions

[cols=2]
[cols="1,4"]
|===
| Name
| Description
| Name| Description
| link:#copyBriefFromCopyBrief[`copyBriefFromCopyBrief`]
| This is the explicit brief&period;
| link:#copyBriefFromExplicitBrief[`copyBriefFromExplicitBrief`]
Expand Down
3 changes: 1 addition & 2 deletions test-files/golden-tests/config/auto-brief/no-auto-brief.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ <h2>Functions</h2>
<table style="table-layout: fixed; width: 100%;">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Name</th><th>Description</th>
</tr>
</thead>
<tbody>
Expand Down
40 changes: 19 additions & 21 deletions ...files/golden-tests/config/auto-function-metadata/brief-from-function-class.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@

=== Types

[cols=2]
[cols="1,4"]
|===
| Name
| Description
| Name| Description
| link:#A[`A`]
| A helper tag
| link:#X[`X`]
Expand Down Expand Up @@ -46,10 +45,9 @@ struct X;

=== Member Functions

[cols=2]
[cols="1,4"]
|===
| Name
| Description
| Name| Description
| link:#X-2constructor-08[`X`] [.small]#[constructor]#
| Constructors
| link:#X-2destructor[`&#126;X`] [.small]#[destructor]#
Expand Down Expand Up @@ -164,10 +162,10 @@ X(link:#X[X] const& other) = default;

=== Parameters

[cols=2]
[cols="1,4"]
|===
| Name
| Description
|Name|Description

| *other*
| The object to copy construct from
|===
Expand All @@ -189,10 +187,10 @@ X(link:#X[X]&& other) = default;

=== Parameters

[cols=2]
[cols="1,4"]
|===
| Name
| Description
|Name|Description

| *other*
| The object to move construct from
|===
Expand All @@ -213,10 +211,10 @@ X(int value);

=== Parameters

[cols=2]
[cols="1,4"]
|===
| Name
| Description
|Name|Description

| *value*
| The value to construct from
|===
Expand All @@ -237,10 +235,10 @@ X(link:#A[A] const& value);

=== Parameters

[cols=2]
[cols="1,4"]
|===
| Name
| Description
|Name|Description

| *value*
| The object to copy construct from
|===
Expand All @@ -261,10 +259,10 @@ X(link:#A[A]&& value);

=== Parameters

[cols=2]
[cols="1,4"]
|===
| Name
| Description
|Name|Description

| *value*
| The object to move construct from
|===
Expand Down
6 changes: 2 additions & 4 deletions test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ <h2>Types</h2>
<table style="table-layout: fixed; width: 100%;">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Name</th><th>Description</th>
</tr>
</thead>
<tbody>
Expand Down Expand Up @@ -62,8 +61,7 @@ <h2>Member Functions</h2>
<table style="table-layout: fixed; width: 100%;">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Name</th><th>Description</th>
</tr>
</thead>
<tbody>
Expand Down
Loading
Loading