Skip to content

feat(HandlebarsGenerator): unify signature helpers #742

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 4 commits into from
Nov 28, 2024
Merged

feat(HandlebarsGenerator): unify signature helpers #742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7a7d336
refactor(HandlebarsGenerator): do not require symbol as hash parameter
alandefreitas Nov 26, 2024
737d24c
refactor(HandlebarsGenerator): single page HTML includes reference title
alandefreitas Nov 26, 2024
4ef1426
feat(templates): common signature entry partial
alandefreitas Nov 26, 2024
52ca248
feat(HandlebarsGenerator): unify signature helpers
alandefreitas Nov 26, 2024
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/layouts/index.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
{{! The section with a symbol in single page output or the symbol page in multi page output }}
{{> symbol symbol=symbol}}
{{> symbol }}
1 change: 0 additions & 1 deletion share/mrdocs/addons/generator/adoc/partials/signature/using.adoc.hbs
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/adoc/partials/symbols/alias.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

[source,cpp,subs="verbatim,macros,-callouts"]
----
{{>signature/alias symbol=symbol}};
{{> signature }};
----

{{#if symbol.doc.description}}
Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/adoc/partials/symbols/concept.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

[source,cpp,subs="verbatim,macros,-callouts"]
----
{{>signature/concept symbol=symbol}};
{{> signature }};
----

{{#if symbol.doc.description}}
Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/adoc/partials/symbols/enum.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

[source,cpp,subs="verbatim,macros,-callouts"]
----
{{>signature/enum symbol=symbol}};
{{> signature }};
----

{{#if symbol.members}}
Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/adoc/partials/symbols/enumerator.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

[source,cpp,subs="verbatim,macros,-callouts"]
----
{{>signature/enumerator symbol=symbol}}
{{> signature }}

----

Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/adoc/partials/symbols/field.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

[source,cpp,subs="verbatim,macros,-callouts"]
----
{{>signature/field symbol=symbol}};
{{> signature }};
----

{{#if symbol.doc.description}}
Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/adoc/partials/symbols/friend.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

[source,cpp,subs="verbatim,macros,-callouts"]
----
{{>signature/friend symbol=symbol}};
{{> signature }};
----

{{#if symbol.doc.description}}
Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/adoc/partials/symbols/function.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

[source,cpp,subs="verbatim,macros,-callouts"]
----
{{>signature/function symbol=symbol}};
{{> signature }};
----

{{#if symbol.doc.description}}
Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/adoc/partials/symbols/guide.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

[source,cpp,subs="verbatim,macros,-callouts"]
----
{{>signature/guide symbol=symbol}};
{{> signature }};
----

{{#if symbol.doc.description}}
Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/adoc/partials/symbols/overloads.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

[source,cpp,subs="verbatim,macros,-callouts"]
----
{{> (concat 'signature' '/' (lookup member 'kind')) symbol=member link=member}};
{{> signature symbol=member link=member}};
----
{{/each}}

Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/adoc/partials/symbols/record.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

[source,cpp,subs="verbatim,macros,-callouts"]
----
{{>signature/record symbol=symbol}};
{{> signature }};
----

{{#with symbol.interface}}
Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/adoc/partials/symbols/typedef.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

[source,cpp,subs="verbatim,macros,-callouts"]
----
{{>signature/typedef symbol=symbol}};
{{> signature }};
----

{{#if symbol.doc.description}}
Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/adoc/partials/symbols/using.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

[source,cpp,subs="verbatim,macros,-callouts"]
----
{{>signature/using symbol=symbol}};
{{> signature }};
----

{{#if symbol.doc.description}}
Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/adoc/partials/symbols/variable.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

[source,cpp,subs="verbatim,macros,-callouts"]
----
{{>signature/variable symbol=symbol}};
{{> signature }};
----

{{#if symbol.doc.description}}
Expand Down
1 change: 1 addition & 0 deletions share/mrdocs/addons/generator/common/partials/signature.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{> (concat 'signature' '/' (lookup symbol 'kind')) }}
0 ...or/adoc/partials/signature/alias.adoc.hbs → ...rator/common/partials/signature/alias.hbs
View file
Open in desktop
File renamed without changes.
0 .../adoc/partials/signature/concept.adoc.hbs → ...tor/common/partials/signature/concept.hbs
View file
Open in desktop
File renamed without changes.
0 ...tor/adoc/partials/signature/enum.adoc.hbs → ...erator/common/partials/signature/enum.hbs
View file
Open in desktop
File renamed without changes.
0 ...oc/partials/signature/enumerator.adoc.hbs → .../common/partials/signature/enumerator.hbs
View file
Open in desktop
File renamed without changes.
0 ...or/adoc/partials/signature/field.adoc.hbs → ...rator/common/partials/signature/field.hbs
View file
Open in desktop
File renamed without changes.
0 ...r/adoc/partials/signature/friend.adoc.hbs → ...ator/common/partials/signature/friend.hbs
View file
Open in desktop
File renamed without changes.
0 ...adoc/partials/signature/function.adoc.hbs → ...or/common/partials/signature/function.hbs
View file
Open in desktop
File renamed without changes.
0 ...or/adoc/partials/signature/guide.adoc.hbs → ...rator/common/partials/signature/guide.hbs
View file
Open in desktop
File renamed without changes.
0 ...doc/partials/signature/namespace.adoc.hbs → ...r/common/partials/signature/namespace.hbs
View file
Open in desktop
File renamed without changes.
0 ...r/adoc/partials/signature/record.adoc.hbs → ...ator/common/partials/signature/record.hbs
View file
Open in desktop
File renamed without changes.
0 ...artials/signature/specialization.adoc.hbs → ...mon/partials/signature/specialization.hbs
View file
Open in desktop
File renamed without changes.
0 .../adoc/partials/signature/typedef.adoc.hbs → ...tor/common/partials/signature/typedef.hbs
View file
Open in desktop
File renamed without changes.
0 ...doc/partials/signature/undefined.adoc.hbs → ...r/common/partials/signature/undefined.hbs
View file
Open in desktop
File renamed without changes.
1 change: 1 addition & 0 deletions share/mrdocs/addons/generator/common/partials/signature/using.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
using {{#if (contains (arr "typename" "enum") symbol.class)}} {{symbol.class}}{{/if}}{{#if symbol.qualifier}}{{>types/name-info symbol.qualifier}}::{{/if}}{{symbol.name}}
0 ...adoc/partials/signature/variable.adoc.hbs → ...or/common/partials/signature/variable.hbs
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/common/partials/symbol.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{{> (concat 'symbols' '/' (lookup symbol 'kind')) symbol=symbol }}
{{> (concat 'symbols' '/' (lookup symbol 'kind')) }}
4 changes: 2 additions & 2 deletions share/mrdocs/addons/generator/common/partials/types/template-args.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{{! Render all template arguments }}
<{{~#each args~}}
{{ str '<' }}{{~#each args~}}
{{~>types/template-arg nolink=../nolink~}}
{{~#if (not @last)}}, {{/if~}}
{{~/each~}}>
{{~/each~}}{{ str '>' }}
4 changes: 2 additions & 2 deletions share/mrdocs/addons/generator/common/partials/types/template-head.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{{! Renders the template head for a template declaration. }}
template<{{#each params}}{{#unless (and @first @last)}}
template{{ str '<' }}{{#each params}}{{#unless (and @first @last)}}
{{/unless}}{{>types/template-param~}}
{{#unless @last}},{{/unless~}}
{{/each}}>{{#if requires}} requires {{requires}}{{/if}}
{{/each}}{{ str '>' }}{{#if requires}} requires {{requires}}{{/if}}
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/html/layouts/index.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
{{! The section with a symbol in single page output or the symbol page in multi page output }}
{{> symbol symbol=symbol}}
{{> symbol }}
3 changes: 3 additions & 0 deletions share/mrdocs/addons/generator/html/layouts/wrapper.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
</head>
<body>
<div>
{{#unless @root.config.multipage }}
<h1>Reference</h1>
{{/unless}}
{{! Content generated with index.hbs }}
{{{contents}}}
</div>
Expand Down
1 change: 0 additions & 1 deletion share/mrdocs/addons/generator/html/partials/signature/alias.html.hbs
View file
Open in desktop

This file was deleted.

3 changes: 0 additions & 3 deletions share/mrdocs/addons/generator/html/partials/signature/concept.html.hbs
View file
Open in desktop

This file was deleted.

2 changes: 0 additions & 2 deletions share/mrdocs/addons/generator/html/partials/signature/enum.html.hbs
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion share/mrdocs/addons/generator/html/partials/signature/enumerator.html.hbs
View file
Open in desktop

This file was deleted.

6 changes: 0 additions & 6 deletions share/mrdocs/addons/generator/html/partials/signature/field.html.hbs
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions share/mrdocs/addons/generator/html/partials/signature/friend.html.hbs
View file
Open in desktop

This file was deleted.

28 changes: 0 additions & 28 deletions share/mrdocs/addons/generator/html/partials/signature/function.html.hbs
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions share/mrdocs/addons/generator/html/partials/signature/guide.html.hbs
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion share/mrdocs/addons/generator/html/partials/signature/namespace.html.hbs
View file
Open in desktop

This file was deleted.

15 changes: 0 additions & 15 deletions share/mrdocs/addons/generator/html/partials/signature/record.html.hbs
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion share/mrdocs/addons/generator/html/partials/signature/specialization.html.hbs
View file
Open in desktop

This file was deleted.

7 changes: 0 additions & 7 deletions share/mrdocs/addons/generator/html/partials/signature/typedef.html.hbs
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion share/mrdocs/addons/generator/html/partials/signature/undefined.html.hbs
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions share/mrdocs/addons/generator/html/partials/signature/using.html.hbs
View file
Open in desktop

This file was deleted.

11 changes: 0 additions & 11 deletions share/mrdocs/addons/generator/html/partials/signature/variable.html.hbs
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/html/partials/symbols/alias.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</code>
</div>
<pre class="source-code cpp">
{{>signature/alias symbol=symbol}};
{{> signature }};
</pre>
</div>
{{#if symbol.doc.description}}
Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/html/partials/symbols/concept.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
</code>
</div>
<pre class="source-code cpp">
{{>signature/concept symbol=symbol}};
{{> signature }};
</pre>
</div>
{{#if symbol.doc.description}}
Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/html/partials/symbols/enum.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</code>
</div>
<pre class="source-code cpp">
{{>signature/enum symbol=symbol}};
{{> signature }};
</pre>
</div>

Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/html/partials/symbols/enumerator.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</code>
</div>
<pre class="source-code cpp">
{{>signature/enumerator symbol=symbol}}
{{> signature }}
</pre>
</div>

Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/html/partials/symbols/field.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</code>
</div>
<pre class="source-code cpp">
{{>signature/field symbol=symbol}};
{{> signature }};
</pre>
</div>

Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/html/partials/symbols/friend.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</code>
</div>
<pre class="source-code cpp">
{{>signature/friend symbol=symbol}};
{{> signature }};
</pre>
</div>

Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/html/partials/symbols/function.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</code>
</div>
<pre class="source-code cpp">
{{>signature/function symbol=symbol}};
{{> signature }};
</pre>
</div>

Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/html/partials/symbols/guide.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</code>
</div>
<pre class="source-code cpp">
{{>signature/guide symbol=symbol}};
{{> signature }};
</pre>
</div>

Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/html/partials/symbols/overloads.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<p>{{{member.doc.brief}}}</p>

<pre><code class="language-cpp">{{> (concat 'signature' '/' (lookup member 'kind')) symbol=member}};</code></pre>
<pre><code class="language-cpp">{{> signature symbol=member }};</code></pre>
<a href="{{{relativize member.url}}}"><em>» more...</em></a>

{{/each}}
Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/html/partials/symbols/record.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</code>
</div>
<pre class="source-code cpp">
{{>signature/record symbol=symbol}};
{{> signature }};
</pre>
</div>

Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/html/partials/symbols/typedef.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</code>
</div>
<pre class="source-code cpp">
{{>signature/typedef symbol=symbol}};
{{> signature }};
</pre>
</div>

Expand Down
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/html/partials/symbols/using.html.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</code>
</div>
<pre class="source-code cpp">
{{>signature/using symbol=symbol}};
{{> signature }};
</pre>
</div>

Expand Down
Loading
Loading