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

alandefreitas · alandefreitas · commit d722b7d09ee2 · 2025-08-22T22:01:47.000-05:00
diff --git a/share/mrdocs/addons/generator/adoc/partials/symbol.adoc.hbs b/share/mrdocs/addons/generator/adoc/partials/symbol.adoc.hbs
@@ -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}}
diff --git a/share/mrdocs/addons/generator/html/partials/symbol.html.hbs b/share/mrdocs/addons/generator/html/partials/symbol.html.hbs
@@ -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}}
diff --git a/test-files/golden-tests/symbols/using/using-function-after.adoc b/test-files/golden-tests/symbols/using/using-function-after.adoc
@@ -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]#
diff --git a/test-files/golden-tests/symbols/using/using-function-after.html b/test-files/golden-tests/symbols/using/using-function-after.html
@@ -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>
diff --git a/test-files/golden-tests/symbols/using/using-function-and-type.adoc b/test-files/golden-tests/symbols/using/using-function-and-type.adoc
@@ -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]#
diff --git a/test-files/golden-tests/symbols/using/using-function-and-type.html b/test-files/golden-tests/symbols/using/using-function-and-type.html
@@ -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>
diff --git a/test-files/golden-tests/symbols/using/using-function-excluded.adoc b/test-files/golden-tests/symbols/using/using-function-excluded.adoc
@@ -61,8 +61,7 @@ using A::f;
 [cols=1]
 |===
 | Name
-| f
+| link:#A-f[A::f]
 |===
 
-
 [.small]#Created with https://www.mrdocs.com[MrDocs]#
diff --git a/test-files/golden-tests/symbols/using/using-function-excluded.html b/test-files/golden-tests/symbols/using/using-function-excluded.html
@@ -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>
diff --git a/test-files/golden-tests/symbols/using/using-function-local-overloads.adoc b/test-files/golden-tests/symbols/using/using-function-local-overloads.adoc
@@ -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]#
diff --git a/test-files/golden-tests/symbols/using/using-function-local-overloads.html b/test-files/golden-tests/symbols/using/using-function-local-overloads.html
@@ -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>
diff --git a/test-files/golden-tests/symbols/using/using-function-overloads.adoc b/test-files/golden-tests/symbols/using/using-function-overloads.adoc
@@ -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]#
diff --git a/test-files/golden-tests/symbols/using/using-function-overloads.html b/test-files/golden-tests/symbols/using/using-function-overloads.html
@@ -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>
diff --git a/test-files/golden-tests/symbols/using/using-function.adoc b/test-files/golden-tests/symbols/using/using-function.adoc
@@ -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;`
@@ -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]#
diff --git a/test-files/golden-tests/symbols/using/using-function.cpp b/test-files/golden-tests/symbols/using/using-function.cpp
@@ -1,5 +1,6 @@
 namespace A
 {
+    /// Function being used
     void f(int);
 }
 
diff --git a/test-files/golden-tests/symbols/using/using-function.html b/test-files/golden-tests/symbols/using/using-function.html
@@ -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>
@@ -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>
diff --git a/test-files/golden-tests/symbols/using/using-function.xml b/test-files/golden-tests/symbols/using/using-function.xml
@@ -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>
diff --git a/test-files/golden-tests/symbols/using/using-member-function.adoc b/test-files/golden-tests/symbols/using/using-member-function.adoc
@@ -213,9 +213,8 @@ using A::f;
 [cols=1]
 |===
 | Name
-| f
+| link:#A-f[A::f]
 |===
-
 [#C-f-03]
 == link:#C[C]::f
 
@@ -233,8 +232,7 @@ using B::f;
 [cols=1]
 |===
 | Name
-| f
+| link:#B-f[B::f]
 |===
 
-
 [.small]#Created with https://www.mrdocs.com[MrDocs]#
diff --git a/test-files/golden-tests/symbols/using/using-member-function.html b/test-files/golden-tests/symbols/using/using-member-function.html
@@ -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>
@@ -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>
diff --git a/test-files/golden-tests/symbols/using/using-multi.adoc b/test-files/golden-tests/symbols/using/using-multi.adoc
@@ -76,9 +76,8 @@ using A::f;
 [cols=1]
 |===
 | Name
-| f
+| link:#A-f[A::f]
 |===
-
 [#g]
 == g
 
@@ -96,8 +95,7 @@ using A::g;
 [cols=1]
 |===
 | Name
-| g
+| link:#A-g[A::g]
 |===
 
-
 [.small]#Created with https://www.mrdocs.com[MrDocs]#
diff --git a/test-files/golden-tests/symbols/using/using-multi.html b/test-files/golden-tests/symbols/using/using-multi.html
@@ -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>
@@ -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>
diff --git a/test-files/golden-tests/symbols/using/using-struct-template.adoc b/test-files/golden-tests/symbols/using/using-struct-template.adoc
@@ -74,9 +74,8 @@ using LongName::S1;
 [cols=1]
 |===
 | Name
-| S1
+| link:#LongName-S1[LongName::S1]
 |===
-
 [#S2]
 == S2
 
@@ -94,8 +93,7 @@ using LongName::S2;
 [cols=1]
 |===
 | Name
-| S2
+| link:#LongName-S2[LongName::S2]
 |===
 
-
 [.small]#Created with https://www.mrdocs.com[MrDocs]#
diff --git a/test-files/golden-tests/symbols/using/using-struct-template.html b/test-files/golden-tests/symbols/using/using-struct-template.html
diff --git a/test-files/golden-tests/symbols/using/using-struct.adoc b/test-files/golden-tests/symbols/using/using-struct.adoc
diff --git a/test-files/golden-tests/symbols/using/using-struct.html b/test-files/golden-tests/symbols/using/using-struct.html
diff --git a/test-files/golden-tests/symbols/using/using-template-function.adoc b/test-files/golden-tests/symbols/using/using-template-function.adoc
diff --git a/test-files/golden-tests/symbols/using/using-template-function.html b/test-files/golden-tests/symbols/using/using-template-function.html
