Skip to content

Commit 3606a89

Browse files
committed
no breadcrumbs in signature declarators
#fix fix #827
1 parent 747e6a7 commit 3606a89

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+739
-469
lines changed

share/mrdocs/addons/generator/common/partials/type/name-info-text.hbs

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@
1212
1313
See: https://mrdocs.com/docs/mrdocs/develop/generators.html#dom_reference
1414
--}}
15-
{{~> type/name-info . link-components-impl=false ~}}
15+
{{~> type/name-infos . link-components-impl=false ~}}

share/mrdocs/addons/generator/common/partials/type/name-info.hbs

+5-20
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,8 @@
1212
1313
See: https://mrdocs.com/docs/mrdocs/develop/generators.html#dom_reference
1414
--}}
15-
{{#if symbol.isImplementationDefined~}}
16-
{{! The name refers to a symbol that's implementation defined. These are special names that should not be linked. ~}}
17-
{{ str '/* '}}implementation-defined{{ str ' */'~}}
18-
{{else~}}
19-
{{#if prefix~}}
20-
{{> type/name-info prefix link-components-impl=link-components-impl~}}::
21-
{{~/if~}}
22-
{{! Render the name of the symbol. ~}}
23-
{{#if (and symbol.url (or link-components-impl (is_undefined link-components-impl)))~}}
24-
{{! Link to the symbol's documentation. ~}}
25-
{{#>markup/a href=symbol.url}}{{name}}{{/markup/a~}}
26-
{{else~}}
27-
{{! No link, just the name. ~}}
28-
{{name~}}
29-
{{/if~}}
30-
{{#if args~}}
31-
{{! Render the template arguments of the symbol. ~}}
32-
{{>template/args args=args link-components-impl=link-components-impl~}}
33-
{{/if~}}
34-
{{/if~}}
15+
{{#if (and symbol.url (or link-components-impl (is_undefined link-components-impl))) ~}}
16+
{{~#>markup/a href=symbol.url}}{{> type/name-info-text . ~}}{{/markup/a~}}
17+
{{~else~}}
18+
{{~> type/name-info-text . ~}}
19+
{{~/if~}}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{{!--
2+
Renders a Name Info object with links to any named components.
3+
4+
Name Info objects are fields of a Type Object when
5+
they carry information about the Symbol the type
6+
refers to, including its name.
7+
8+
Expected Context: {Name Info Object}
9+
10+
Example:
11+
{{> type/name-info name }}
12+
13+
See: https://mrdocs.com/docs/mrdocs/develop/generators.html#dom_reference
14+
--}}
15+
{{#if symbol.isImplementationDefined~}}
16+
{{! The name refers to a symbol that's implementation defined. These are special names that should not be linked. ~}}
17+
{{ str '/* '}}implementation-defined{{ str ' */'~}}
18+
{{else~}}
19+
{{#if prefix~}}
20+
{{> type/name-info prefix link-components-impl=link-components-impl~}}::
21+
{{~/if~}}
22+
{{! Render the name of the symbol. ~}}
23+
{{#if (and symbol.url (or link-components-impl (is_undefined link-components-impl)))~}}
24+
{{! Link to the symbol's documentation. ~}}
25+
{{#>markup/a href=symbol.url}}{{name}}{{/markup/a~}}
26+
{{else~}}
27+
{{! No link, just the name. ~}}
28+
{{name~}}
29+
{{/if~}}
30+
{{#if args~}}
31+
{{! Render the template arguments of the symbol. ~}}
32+
{{>template/args args=args link-components-impl=link-components-impl~}}
33+
{{/if~}}
34+
{{/if~}}

test-files/golden-tests/config/auto-relates/enum.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Declared in `<enum.cpp>`
150150

151151
[source,cpp,subs="verbatim,replacements,macros,-callouts"]
152152
----
153-
link:#SmallVector[SmallVector]<link:#E[E], 3>
153+
link:#SmallVector[SmallVector<E, 3>]
154154
makeEs();
155155
----
156156

@@ -169,7 +169,7 @@ Declared in `<enum.cpp>`
169169

170170
[source,cpp,subs="verbatim,replacements,macros,-callouts"]
171171
----
172-
link:#Result[Result]<link:#E[E]>
172+
link:#Result[Result<E>]
173173
tryMakeE();
174174
----
175175

test-files/golden-tests/config/auto-relates/enum.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ <h3>Synopsis</h3>
215215
Declared in <code>&lt;enum.cpp&gt;</code></div>
216216
<pre>
217217
<code class="source-code cpp">
218-
<a href="#SmallVector">SmallVector</a>&lt;<a href="#E">E</a>, 3&gt;
218+
<a href="#SmallVector">SmallVector&lt;E, 3&gt;</a>
219219
makeEs();
220220
</code>
221221
</pre>
@@ -239,7 +239,7 @@ <h3>Synopsis</h3>
239239
Declared in <code>&lt;enum.cpp&gt;</code></div>
240240
<pre>
241241
<code class="source-code cpp">
242-
<a href="#Result">Result</a>&lt;<a href="#E">E</a>&gt;
242+
<a href="#Result">Result&lt;E&gt;</a>
243243
tryMakeE();
244244
</code>
245245
</pre>

test-files/golden-tests/config/auto-relates/qualified.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Declared in `&lt;qualified&period;cpp&gt;`
9393
[source,cpp,subs="verbatim,replacements,macros,-callouts"]
9494
----
9595
void
96-
f4(link:#N[N]::link:#N-B[B] const&);
96+
f4(link:#N-B[N::B] const&);
9797
----
9898

9999
[#N-B]
@@ -153,7 +153,7 @@ Declared in `&lt;qualified&period;cpp&gt;`
153153
[source,cpp,subs="verbatim,replacements,macros,-callouts"]
154154
----
155155
void
156-
f3(link:#N[N]::link:#N-B[B] const&);
156+
f3(link:#N-B[N::B] const&);
157157
----
158158

159159
[#O]
@@ -181,7 +181,7 @@ Declared in `&lt;qualified&period;cpp&gt;`
181181
[source,cpp,subs="verbatim,replacements,macros,-callouts"]
182182
----
183183
void
184-
f6(link:#N[N]::link:#N-B[B] const&);
184+
f6(link:#N-B[N::B] const&);
185185
----
186186

187187
[#A]
@@ -237,7 +237,7 @@ Declared in `&lt;qualified&period;cpp&gt;`
237237
[source,cpp,subs="verbatim,replacements,macros,-callouts"]
238238
----
239239
void
240-
f5(link:#N[N]::link:#N-B[B] const&);
240+
f5(link:#N-B[N::B] const&);
241241
----
242242

243243

test-files/golden-tests/config/auto-relates/qualified.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ <h3>Synopsis</h3>
134134
<pre>
135135
<code class="source-code cpp">
136136
void
137-
f4(<a href="#N">N</a>::<a href="#N-B">B</a> const&);
137+
f4(<a href="#N-B">N::B</a> const&);
138138
</code>
139139
</pre>
140140
</div>
@@ -212,7 +212,7 @@ <h3>Synopsis</h3>
212212
<pre>
213213
<code class="source-code cpp">
214214
void
215-
f3(<a href="#N">N</a>::<a href="#N-B">B</a> const&);
215+
f3(<a href="#N-B">N::B</a> const&);
216216
</code>
217217
</pre>
218218
</div>
@@ -251,7 +251,7 @@ <h3>Synopsis</h3>
251251
<pre>
252252
<code class="source-code cpp">
253253
void
254-
f6(<a href="#N">N</a>::<a href="#N-B">B</a> const&);
254+
f6(<a href="#N-B">N::B</a> const&);
255255
</code>
256256
</pre>
257257
</div>
@@ -327,7 +327,7 @@ <h3>Synopsis</h3>
327327
<pre>
328328
<code class="source-code cpp">
329329
void
330-
f5(<a href="#N">N</a>::<a href="#N-B">B</a> const&);
330+
f5(<a href="#N-B">N::B</a> const&);
331331
</code>
332332
</pre>
333333
</div>

test-files/golden-tests/config/auto-relates/return-type.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Declared in `&lt;return&hyphen;type&period;cpp&gt;`
142142

143143
[source,cpp,subs="verbatim,replacements,macros,-callouts"]
144144
----
145-
link:#SmallVector[SmallVector]&lt;link:#A[A], 3&gt;
145+
link:#SmallVector[SmallVector&lt;A, 3&gt;]
146146
makeAs();
147147
----
148148

@@ -161,7 +161,7 @@ Declared in `&lt;return&hyphen;type&period;cpp&gt;`
161161

162162
[source,cpp,subs="verbatim,replacements,macros,-callouts"]
163163
----
164-
link:#Result[Result]&lt;link:#A[A]&gt;
164+
link:#Result[Result&lt;A&gt;]
165165
tryMakeA();
166166
----
167167

test-files/golden-tests/config/auto-relates/return-type.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ <h3>Synopsis</h3>
191191
Declared in <code>&lt;return-type.cpp&gt;</code></div>
192192
<pre>
193193
<code class="source-code cpp">
194-
<a href="#SmallVector">SmallVector</a>&lt;<a href="#A">A</a>, 3&gt;
194+
<a href="#SmallVector">SmallVector&lt;A, 3&gt;</a>
195195
makeAs();
196196
</code>
197197
</pre>
@@ -215,7 +215,7 @@ <h3>Synopsis</h3>
215215
Declared in <code>&lt;return-type.cpp&gt;</code></div>
216216
<pre>
217217
<code class="source-code cpp">
218-
<a href="#Result">Result</a>&lt;<a href="#A">A</a>&gt;
218+
<a href="#Result">Result&lt;A&gt;</a>
219219
tryMakeA();
220220
</code>
221221
</pre>

test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Declared in `&lt;extract&hyphen;implicit&hyphen;specializations&period;cpp&gt;`
2323
[source,cpp,subs="verbatim,replacements,macros,-callouts"]
2424
----
2525
struct A
26-
: link:#B-00[B]&lt;int&gt;;
26+
: link:#B-00[B&lt;int&gt;];
2727
----
2828

2929
=== Base Classes
@@ -32,7 +32,7 @@ struct A
3232
|===
3333
| Name
3434
| Description
35-
| `link:#B-00[B]&lt;int&gt;`
35+
| `link:#B-00[B&lt;int&gt;]`
3636
|
3737
|===
3838

test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ <h3>Synopsis</h3>
3535
<pre>
3636
<code class="source-code cpp">
3737
struct A
38-
: <a href="#B-00">B</a>&lt;int&gt;;
38+
: <a href="#B-00">B&lt;int&gt;</a>;
3939
</code>
4040
</pre>
4141
</div>
@@ -49,7 +49,7 @@ <h2>Base Classes</h2>
4949
</tr>
5050
</thead>
5151
<tbody>
52-
<tr><td><code><a href="#B-00">B</a>&lt;int&gt;</code></td><td><span></span></td></tr>
52+
<tr><td><code><a href="#B-00">B&lt;int&gt;</a></code></td><td><span></span></td></tr>
5353
</tbody>
5454
</table>
5555
</div>

test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Declared in `&lt;no&hyphen;extract&hyphen;implicit&hyphen;specializations&period
2323
[source,cpp,subs="verbatim,replacements,macros,-callouts"]
2424
----
2525
struct A
26-
: link:#B[B]&lt;int&gt;;
26+
: link:#B[B&lt;int&gt;];
2727
----
2828

2929
=== Base Classes
@@ -32,7 +32,7 @@ struct A
3232
|===
3333
| Name
3434
| Description
35-
| `link:#B[B]&lt;int&gt;`
35+
| `link:#B[B&lt;int&gt;]`
3636
|
3737
|===
3838

test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ <h3>Synopsis</h3>
3535
<pre>
3636
<code class="source-code cpp">
3737
struct A
38-
: <a href="#B">B</a>&lt;int&gt;;
38+
: <a href="#B">B&lt;int&gt;</a>;
3939
</code>
4040
</pre>
4141
</div>
@@ -49,7 +49,7 @@ <h2>Base Classes</h2>
4949
</tr>
5050
</thead>
5151
<tbody>
52-
<tr><td><code><a href="#B">B</a>&lt;int&gt;</code></td><td><span></span></td></tr>
52+
<tr><td><code><a href="#B">B&lt;int&gt;</a></code></td><td><span></span></td></tr>
5353
</tbody>
5454
</table>
5555
</div>

test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Declared in `&lt;excluded&hyphen;namespace&hyphen;alias&period;cpp&gt;`
4343

4444
[source,cpp,subs="verbatim,replacements,macros,-callouts"]
4545
----
46-
namespace E = link:#B[B]::S::E;
46+
namespace E = B::S::E;
4747
----
4848

4949

test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ <h3>Synopsis</h3>
6969
Declared in <code>&lt;excluded-namespace-alias.cpp&gt;</code></div>
7070
<pre>
7171
<code class="source-code cpp">
72-
namespace E = <a href="#B">B</a>::S::E;
72+
namespace E = B::S::E;
7373
</code>
7474
</pre>
7575
</div>

test-files/golden-tests/filters/symbol-name/impl-defined-member.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Declared in `&lt;impl&hyphen;defined&hyphen;member&period;cpp&gt;`
6565

6666
[source,cpp,subs="verbatim,replacements,macros,-callouts"]
6767
----
68-
constexpr link:#regular[regular]::link:#regular-absolute_uri_rule_t[absolute&lowbar;uri&lowbar;rule&lowbar;t] regular&lowbar;absolute&lowbar;uri&lowbar;rule = &lcub;&rcub;;
68+
constexpr link:#regular-absolute_uri_rule_t[regular::absolute&lowbar;uri&lowbar;rule&lowbar;t] regular&lowbar;absolute&lowbar;uri&lowbar;rule = &lcub;&rcub;;
6969
----
7070

7171

test-files/golden-tests/filters/symbol-name/impl-defined-member.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h3>Synopsis</h3>
9797
Declared in <code>&lt;impl-defined-member.cpp&gt;</code></div>
9898
<pre>
9999
<code class="source-code cpp">
100-
constexpr <a href="#regular">regular</a>::<a href="#regular-absolute_uri_rule_t">absolute_uri_rule_t</a> regular_absolute_uri_rule = {};
100+
constexpr <a href="#regular-absolute_uri_rule_t">regular::absolute_uri_rule_t</a> regular_absolute_uri_rule = {};
101101
</code>
102102
</pre>
103103
</div>

0 commit comments

Comments
 (0)