Skip to content

feat(handlebars): using declaration page includes shadows and briefs #975

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
Aug 23, 2025
+97 −63
Merged

feat(handlebars): using declaration page includes shadows and briefs #975

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
15 changes: 13 additions & 2 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 @@ -134,14 +134,25 @@
{{! Using symbols }}
{{#if symbol.shadows}}
{{#> markup/dynamic-level-h }}Introduced Symbols{{/markup/dynamic-level-h}}
{{#if (any_of_by symbol.shadows "doc")}}
[cols=2]
|===
| Name
| Description
{{#each symbol.shadows}}
| {{> symbol/qualified-name . }}
| {{> javadoc/inline-brief doc.brief }}
{{/each}}
|===
{{else}}
[cols=1]
|===
| Name
{{#each symbol.shadows}}
| {{name}}
| {{> symbol/qualified-name . }}
{{/each}}
|===

{{/if}}
{{/if}}
{{! Exceptions }}
{{#if symbol.doc.exceptions}}
Expand Down
21 changes: 20 additions & 1 deletion 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 @@ -183,20 +183,39 @@
{{#if symbol.shadows}}
<div>
{{#> markup/dynamic-level-h level=2 }}Introduced Symbols{{/markup/dynamic-level-h}}
{{#if (any_of_by symbol.shadows "doc")}}
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
{{#each symbol.shadows}}
<tr>
<td>{{name}}</td>
<td>{{> symbol/qualified-name . }}</td>
<td>{{> javadoc/inline-brief doc.brief }}</td>
</tr>
{{/each}}
</tbody>
</table>
{{else}}
<table>
<thead>
<tr>
<th>Name</th>
</tr>
</thead>
<tbody>
{{#each symbol.shadows}}
<tr>
<td>{{> symbol/qualified-name . }}</td>
</tr>
{{/each}}
</tbody>
</table>
{{/if}}
</div>

{{/if}}
Expand Down
3 changes: 1 addition & 2 deletions test-files/golden-tests/symbols/using/using-function-after.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,7 @@ using A::f;
[cols=1]
|===
| Name
| f
| link:#A-f-01[A::f]
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
2 changes: 1 addition & 1 deletion test-files/golden-tests/symbols/using/using-function-after.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ <h3>Introduced Symbols</h3>
</thead>
<tbody>
<tr>
<td>f</td>
<td><a href="#A-f-01">A::f</a></td>
</tr>
</tbody>
</table>
Expand Down
5 changes: 2 additions & 3 deletions test-files/golden-tests/symbols/using/using-function-and-type.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,8 @@ using A::f;
[cols=1]
|===
| Name
| f
| f
| link:#A-f-05[A::f]
| link:#A-f-01[A::f]
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
4 changes: 2 additions & 2 deletions test-files/golden-tests/symbols/using/using-function-and-type.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,10 +181,10 @@ <h3>Introduced Symbols</h3>
</thead>
<tbody>
<tr>
<td>f</td>
<td><a href="#A-f-05">A::f</a></td>
</tr>
<tr>
<td>f</td>
<td><a href="#A-f-01">A::f</a></td>
</tr>
</tbody>
</table>
Expand Down
3 changes: 1 addition & 2 deletions test-files/golden-tests/symbols/using/using-function-excluded.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,7 @@ using A::f;
[cols=1]
|===
| Name
| f
| link:#A-f[A::f]
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
2 changes: 1 addition & 1 deletion test-files/golden-tests/symbols/using/using-function-excluded.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ <h3>Introduced Symbols</h3>
</thead>
<tbody>
<tr>
<td>f</td>
<td><a href="#A-f">A::f</a></td>
</tr>
</tbody>
</table>
Expand Down
7 changes: 3 additions & 4 deletions test-files/golden-tests/symbols/using/using-function-local-overloads.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,10 +148,9 @@ using A::f;
[cols=1]
|===
| Name
| f
| f
| f
| link:#A-f-037[A::f]
| link:#A-f-039[A::f]
| link:#A-f-01[A::f]
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
6 changes: 3 additions & 3 deletions test-files/golden-tests/symbols/using/using-function-local-overloads.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,13 +195,13 @@ <h3>Introduced Symbols</h3>
</thead>
<tbody>
<tr>
<td>f</td>
<td><a href="#A-f-037">A::f</a></td>
</tr>
<tr>
<td>f</td>
<td><a href="#A-f-039">A::f</a></td>
</tr>
<tr>
<td>f</td>
<td><a href="#A-f-01">A::f</a></td>
</tr>
</tbody>
</table>
Expand Down
7 changes: 3 additions & 4 deletions test-files/golden-tests/symbols/using/using-function-overloads.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,10 +127,9 @@ using A::f;
[cols=1]
|===
| Name
| f
| f
| f
| link:#A-f-037[A::f]
| link:#A-f-039[A::f]
| link:#A-f-01[A::f]
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
6 changes: 3 additions & 3 deletions test-files/golden-tests/symbols/using/using-function-overloads.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,13 +166,13 @@ <h3>Introduced Symbols</h3>
</thead>
<tbody>
<tr>
<td>f</td>
<td><a href="#A-f-037">A::f</a></td>
</tr>
<tr>
<td>f</td>
<td><a href="#A-f-039">A::f</a></td>
</tr>
<tr>
<td>f</td>
<td><a href="#A-f-01">A::f</a></td>
</tr>
</tbody>
</table>
Expand Down
13 changes: 9 additions & 4 deletions test-files/golden-tests/symbols/using/using-function.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,19 @@

=== Functions

[cols=1]
[cols=2]
|===
| Name
| Description
| link:#A-f[`f`]
| Function being used
|===

[#A-f]
== link:#A[A]::f

Function being used

=== Synopsis

Declared in `&lt;using&hyphen;function&period;cpp&gt;`
Expand All @@ -62,11 +66,12 @@ using A::f;

=== Introduced Symbols

[cols=1]
[cols=2]
|===
| Name
| f
| Description
| link:#A-f[A::f]
| Function being used
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
1 change: 1 addition & 0 deletions test-files/golden-tests/symbols/using/using-function.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
namespace A
{
/// Function being used
void f(int);
}

Expand Down
11 changes: 9 additions & 2 deletions test-files/golden-tests/symbols/using/using-function.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,23 @@ <h2>Functions</h2>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="#A-f"><code>f</code></a> </td></tr>
<td><a href="#A-f"><code>f</code></a> </td><td><span>Function being used</span></td></tr>
</tbody>
</table>

</div>
<div>
<div>
<h2 id="A-f"><a href="#A-f">A::f</a></h2>
<div>
<span>Function being used</span>

</div>
</div>
<div>
<h3>Synopsis</h3>
Expand Down Expand Up @@ -95,11 +100,13 @@ <h3>Introduced Symbols</h3>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>f</td>
<td><a href="#A-f">A::f</a></td>
<td><span>Function being used</span></td>
</tr>
</tbody>
</table>
Expand Down
9 changes: 7 additions & 2 deletions test-files/golden-tests/symbols/using/using-function.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,19 @@
<namespace id="//////////////////////////8=">
<namespace name="A" id="jQQu/8mLNzRQvGtbkKMwwloVDpw=">
<function name="f" id="FuaTgMW0VtO+b4uzr/DCmx9vlb0=">
<file short-path="using-function.cpp" source-path="using-function.cpp" line="3"/>
<file short-path="using-function.cpp" source-path="using-function.cpp" line="4"/>
<param>
<type name="int"/>
</param>
<doc>
<brief>
<text>Function being used</text>
</brief>
</doc>
</function>
</namespace>
<using id="FhSdC4kR2+KOxLCiCUQ9mu1WNoY=" class="using" qualifier="A::f">
<file short-path="using-function.cpp" source-path="using-function.cpp" line="7"/>
<file short-path="using-function.cpp" source-path="using-function.cpp" line="8"/>
<doc>
<brief>
<text>f is also available in the global namespace</text>
Expand Down
6 changes: 2 additions & 4 deletions test-files/golden-tests/symbols/using/using-member-function.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,9 +213,8 @@ using A::f;
[cols=1]
|===
| Name
| f
| link:#A-f[A::f]
|===

[#C-f-03]
== link:#C[C]::f

Expand All @@ -233,8 +232,7 @@ using B::f;
[cols=1]
|===
| Name
| f
| link:#B-f[B::f]
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
4 changes: 2 additions & 2 deletions test-files/golden-tests/symbols/using/using-member-function.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ <h3>Introduced Symbols</h3>
</thead>
<tbody>
<tr>
<td>f</td>
<td><a href="#A-f">A::f</a></td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -323,7 +323,7 @@ <h3>Introduced Symbols</h3>
</thead>
<tbody>
<tr>
<td>f</td>
<td><a href="#B-f">B::f</a></td>
</tr>
</tbody>
</table>
Expand Down
6 changes: 2 additions & 4 deletions test-files/golden-tests/symbols/using/using-multi.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,8 @@ using A::f;
[cols=1]
|===
| Name
| f
| link:#A-f[A::f]
|===

[#g]
== g

Expand All @@ -96,8 +95,7 @@ using A::g;
[cols=1]
|===
| Name
| g
| link:#A-g[A::g]
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
4 changes: 2 additions & 2 deletions test-files/golden-tests/symbols/using/using-multi.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ <h3>Introduced Symbols</h3>
</thead>
<tbody>
<tr>
<td>f</td>
<td><a href="#A-f">A::f</a></td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -143,7 +143,7 @@ <h3>Introduced Symbols</h3>
</thead>
<tbody>
<tr>
<td>g</td>
<td><a href="#A-g">A::g</a></td>
</tr>
</tbody>
</table>
Expand Down
6 changes: 2 additions & 4 deletions test-files/golden-tests/symbols/using/using-struct-template.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,8 @@ using LongName::S1;
[cols=1]
|===
| Name
| S1
| link:#LongName-S1[LongName::S1]
|===

[#S2]
== S2

Expand All @@ -94,8 +93,7 @@ using LongName::S2;
[cols=1]
|===
| Name
| S2
| link:#LongName-S2[LongName::S2]
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#
Loading
Loading