Skip to content

adoc: tables for symbols have headers #1027

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

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
+26 −26
Open

adoc: tables for symbols have headers #1027

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
52 changes: 26 additions & 26 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"]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh... That's good.

|===
| Name
| Description
|Name|Description
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure that's necessary when you define "cols", but that's also fine.


{{#each (filter_by symbol.bases "isPublic")}}
| {{#>markup/code}}{{> type/declarator type }}{{/markup/code}}
| {{> javadoc/inline-brief 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}}
| {{> javadoc/inline-brief symbol.doc.brief }}
Expand All @@ -72,10 +72,10 @@
{{#if symbol.constants}}
{{#> markup/dynamic-level-h }}Members{{/markup/dynamic-level-h}}

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

{{#each (filter_by symbol.constants "isRegular" "isSeeBelow")}}
|`{{>symbol/name-text .}}`
|{{> javadoc/inline-brief doc.brief }}
Expand All @@ -87,10 +87,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 @@ -111,7 +111,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
Comment on lines 116 to 117
Copy link

Copilot AI Sep 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These table headers should be updated to match the consistent format used elsewhere in the file. Replace the separate header rows with the single-line format |Name|Description and add a blank line after for consistency.

Suggested change
| Name
| Description
|Name|Description

Copilot uses AI. Check for mistakes.

Expand All @@ -125,10 +125,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 @@ -151,10 +151,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 . }}
| {{> javadoc/inline-brief doc.brief }}
Expand All @@ -173,7 +173,7 @@
{{! Exceptions }}
{{#if symbol.doc.exceptions}}
{{#> markup/dynamic-level-h }}Exceptions{{/markup/dynamic-level-h}}
[cols=2]
[cols="1,4"]
|===
| Name
| Thrown on
Comment on lines 178 to 179
Copy link

Copilot AI Sep 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These table headers should be updated to match the consistent format used elsewhere in the file. Replace the separate header rows with the single-line format |Name|Thrown on and add a blank line after for consistency.

Suggested change
| Name
| Thrown on
|Name|Thrown on

Copilot uses AI. Check for mistakes.

Expand Down Expand Up @@ -201,10 +201,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}}*
| {{>javadoc/block .}}
Expand All @@ -215,10 +215,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}}
| {{>javadoc/block .}}
Expand Down
Loading