Skip to content

templates include base classes #887

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
Mar 19, 2025
Merged

templates include base classes #887

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
14 changes: 14 additions & 0 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 @@ -28,6 +28,20 @@

{{> symbol/signatures symbol }}
{{/unless}}
{{! Base classes }}
{{#if (any_of_by symbol.bases "isPublic")}}
{{#> markup/dynamic-level-h }}Base Classes{{/markup/dynamic-level-h}}
[,cols=2]
|===
| Name
| Description
{{#each (filter_by symbol.bases "isPublic")}}
| {{#>markup/code}}{{> type/declarator type }}{{/markup/code}}
| {{> javadoc/inline-brief symbol.doc.brief }}
{{/each}}
|===

{{/if}}
{{! Members }}
{{! Record interface }}
{{#if (eq symbol.kind "record")}}
Expand Down
19 changes: 19 additions & 0 deletions share/mrdocs/addons/generator/html/partials/symbol.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,25 @@

</div>
{{/unless}}
{{! Base classes }}
{{#if (any_of_by symbol.bases "isPublic")}}
<div>
{{#> markup/dynamic-level-h }}Base Classes{{/markup/dynamic-level-h}}
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
{{#each (filter_by symbol.bases "isPublic")}}
<tr><td>{{#>markup/code}}{{> type/declarator type }}{{/markup/code}}</td><td>{{> javadoc/inline-brief symbol.doc.brief }}</td></tr>
{{/each}}
</tbody>
</table>
</div>
{{/if}}
{{! Members }}
{{! Record interface }}
{{#if (eq symbol.kind "record")}}
Expand Down
4 changes: 4 additions & 0 deletions src/lib/Metadata/Info/Record.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,12 @@ tag_invoke(
DomCorpus const* domCorpus)
{
io.map("access", I.Access);
io.map("isPublic", I.Access == AccessKind::Public);
io.map("isProtected", I.Access == AccessKind::Protected);
io.map("isPrivate", I.Access == AccessKind::Private);
io.map("isVirtual", I.IsVirtual);
io.map("type", dom::ValueFrom(I.Type, domCorpus));
io.map("symbol", I.Type->namedSymbol());
}

void
Expand Down
30 changes: 30 additions & 0 deletions test-files/golden-tests/config/auto-relates/derived.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,16 @@ struct A
: <<ABase,ABase>>;
----

=== Base Classes

[,cols=2]
|===
| Name
| Description
| `<<ABase,ABase>>`
| A base class for non&hyphen;member functions
|===

=== Non-Member Functions

[,cols=2]
Expand Down Expand Up @@ -134,6 +144,16 @@ struct AView
: <<ABase,ABase>>;
----

=== Base Classes

[,cols=2]
|===
| Name
| Description
| `<<ABase,ABase>>`
| A base class for non&hyphen;member functions
|===

=== Non-Member Functions

[,cols=2]
Expand Down Expand Up @@ -177,6 +197,16 @@ struct AView2
: <<AView,AView>>;
----

=== Base Classes

[,cols=2]
|===
| Name
| Description
| `<<AView,AView>>`
| A view of A
|===

=== Non-Member Functions

[,cols=2]
Expand Down
42 changes: 42 additions & 0 deletions test-files/golden-tests/config/auto-relates/derived.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,20 @@ <h3>Synopsis</h3>
</code>
</pre>
</div>
<div>
<h2>Base Classes</h2>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr><td><code><a href="#ABase">ABase</a></code></td><td><span>A base class for non-member functions</span></td></tr>
</tbody>
</table>
</div>


<div>
Expand Down Expand Up @@ -162,6 +176,20 @@ <h3>Synopsis</h3>
</code>
</pre>
</div>
<div>
<h2>Base Classes</h2>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr><td><code><a href="#ABase">ABase</a></code></td><td><span>A base class for non-member functions</span></td></tr>
</tbody>
</table>
</div>


<div>
Expand Down Expand Up @@ -217,6 +245,20 @@ <h3>Synopsis</h3>
</code>
</pre>
</div>
<div>
<h2>Base Classes</h2>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr><td><code><a href="#AView">AView</a></code></td><td><span>A view of A</span></td></tr>
</tbody>
</table>
</div>


<div>
Expand Down
10 changes: 10 additions & 0 deletions test-files/golden-tests/config/extract-implicit-specializations/base.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,16 @@ struct A
: <<B,B>>;
----

=== Base Classes

[,cols=2]
|===
| Name
| Description
| `<<B,B>>`
|
|===

=== Member Functions

[cols=1]
Expand Down
14 changes: 14 additions & 0 deletions test-files/golden-tests/config/extract-implicit-specializations/base.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,20 @@ <h3>Synopsis</h3>
</code>
</pre>
</div>
<div>
<h2>Base Classes</h2>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr><td><code><a href="#B">B</a></code></td><td><span></span></td></tr>
</tbody>
</table>
</div>
<h2>Member Functions</h2>
<table style="table-layout: fixed; width: 100%;">
<thead>
Expand Down
10 changes: 10 additions & 0 deletions ...s/config/extract-implicit-specializations/extract-implicit-specializations.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,16 @@ struct A
: <<B-00,B>>&lt;int&gt;;
----

=== Base Classes

[,cols=2]
|===
| Name
| Description
| `<<B-00,B>>&lt;int&gt;`
|
|===

=== Member Functions

[cols=1]
Expand Down
14 changes: 14 additions & 0 deletions ...olden-tests/config/extract-implicit-specializations/extract-implicit-specializations.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,20 @@ <h3>Synopsis</h3>
</code>
</pre>
</div>
<div>
<h2>Base Classes</h2>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr><td><code><a href="#B-00">B</a>&lt;int&gt;</code></td><td><span></span></td></tr>
</tbody>
</table>
</div>
<h2>Member Functions</h2>
<table style="table-layout: fixed; width: 100%;">
<thead>
Expand Down
10 changes: 10 additions & 0 deletions ...onfig/extract-implicit-specializations/no-extract-implicit-specializations.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,16 @@ struct A
: <<B,B>>&lt;int&gt;;
----

=== Base Classes

[,cols=2]
|===
| Name
| Description
| `<<B,B>>&lt;int&gt;`
|
|===

=== Member Functions

[cols=1]
Expand Down
14 changes: 14 additions & 0 deletions ...en-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,20 @@ <h3>Synopsis</h3>
</code>
</pre>
</div>
<div>
<h2>Base Classes</h2>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr><td><code><a href="#B">B</a>&lt;int&gt;</code></td><td><span></span></td></tr>
</tbody>
</table>
</div>
<h2>Member Functions</h2>
<table style="table-layout: fixed; width: 100%;">
<thead>
Expand Down
20 changes: 20 additions & 0 deletions test-files/golden-tests/config/inherit-base-members/base-overload-set.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,16 @@ class Base
: public <<ConstBase,ConstBase>>;
----

=== Base Classes

[,cols=2]
|===
| Name
| Description
| `<<ConstBase,ConstBase>>`
|
|===

=== Member Functions

[cols=2]
Expand Down Expand Up @@ -111,6 +121,16 @@ class C
: public <<Base,Base>>;
----

=== Base Classes

[,cols=2]
|===
| Name
| Description
| `<<Base,Base>>`
|
|===

=== Member Functions

[cols=2]
Expand Down
28 changes: 28 additions & 0 deletions test-files/golden-tests/config/inherit-base-members/base-overload-set.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,20 @@ <h3>Synopsis</h3>
</code>
</pre>
</div>
<div>
<h2>Base Classes</h2>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr><td><code><a href="#ConstBase">ConstBase</a></code></td><td><span></span></td></tr>
</tbody>
</table>
</div>
<h2>Member Functions</h2>
<table style="table-layout: fixed; width: 100%;">
<thead>
Expand Down Expand Up @@ -146,6 +160,20 @@ <h3>Synopsis</h3>
</code>
</pre>
</div>
<div>
<h2>Base Classes</h2>
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr><td><code><a href="#Base">Base</a></code></td><td><span></span></td></tr>
</tbody>
</table>
</div>
<h2>Member Functions</h2>
<table style="table-layout: fixed; width: 100%;">
<thead>
Expand Down
22 changes: 22 additions & 0 deletions test-files/golden-tests/config/inherit-base-members/copy-dependencies.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,16 @@ class base
: public <<base_base,base&lowbar;base>>;
----

=== Base Classes

[,cols=2]
|===
| Name
| Description
| `<<base_base,base&lowbar;base>>`
|
|===

=== Member Functions

[cols=2]
Expand Down Expand Up @@ -245,6 +255,18 @@ class derived
, public excluded&lowbar;base;
----

=== Base Classes

[,cols=2]
|===
| Name
| Description
| `<<base,base>>`
|
| `excluded&lowbar;base`
|
|===

=== Member Functions

[cols=2]
Expand Down
Loading
Loading