Skip to content

Commit 0e8b79f

Browse files
alandefreitasalandefreitas
committed
overloads javadoc
#feat
1 parent 3fe5287 commit 0e8b79f

Some content is hidden

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

56 files changed

+5153
-346
lines changed

‎docs/mrdocs.schema.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@
302302
},
303303
"overloads": {
304304
"default": true,
305-
"description": "When set to `true`, MrDocs detects function overloads and groups them as a single symbol type.",
305+
"description": "When set to `true`, MrDocs detects function overloads and groups them as a single symbol type. The documentation for this new symbol comes from the union of non-ambiguous metadata from the functions.",
306306
"enum": [
307307
true,
308308
false

‎include/mrdocs/Metadata/Javadoc.hpp

+12-2
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,16 @@ struct Text : Node
255255
}
256256
};
257257

258+
MRDOCS_DECL
259+
std::strong_ordering
260+
operator<=>(Polymorphic<Text> const& lhs, Polymorphic<Text> const& rhs);
261+
262+
inline
263+
bool
264+
operator==(Polymorphic<Text> const& lhs, Polymorphic<Text> const& rhs) {
265+
return std::is_eq(lhs <=> rhs);
266+
}
267+
258268
/** A piece of styled text.
259269
*/
260270
struct Styled final : Text
@@ -489,7 +499,7 @@ struct Paragraph : Block
489499
}
490500

491501
auto operator<=>(Paragraph const&) const = default;
492-
bool operator==(Paragraph const&) const noexcept = default;
502+
493503
bool equals(Node const& other) const noexcept override
494504
{
495505
return Kind == other.Kind &&
@@ -518,7 +528,7 @@ struct Brief final : Paragraph
518528
}
519529

520530
auto operator<=>(Brief const&) const = default;
521-
bool operator==(Brief const&) const noexcept = default;
531+
522532
bool equals(Node const& other) const noexcept override
523533
{
524534
return Kind == other.Kind &&

‎share/mrdocs/addons/generator/adoc/partials/symbol.adoc.hbs

+1-58
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
{{/if}}
2525
{{! Synopsis }}
2626
{{#unless (eq symbol.kind "namespace")}}
27-
{{#> markup/dynamic-level-h }}Synopsis{{/markup/dynamic-level-h}}
27+
{{#> markup/dynamic-level-h }}{{#if (ne symbol.kind "overloads")}}Synopsis{{else}}Synopses{{/if}}{{/markup/dynamic-level-h}}
2828

2929
{{>location/source dcl=(primary_location symbol)}}
3030

@@ -89,7 +89,6 @@
8989

9090
{{/if}}
9191
{{! Exceptions }}
92-
{{#if (ne symbol.kind "overloads")}}
9392
{{#if symbol.doc.exceptions}}
9493
{{#> markup/dynamic-level-h }}Exceptions{{/markup/dynamic-level-h}}
9594

@@ -103,24 +102,6 @@
103102
{{/each}}
104103
|===
105104

106-
{{/if}}
107-
{{else}}
108-
{{#with (flattenUnique symbol.members "doc.exceptions" "exception") as |allExceptions|}}
109-
{{#if (ne (len allExceptions) 0)}}
110-
{{#> markup/dynamic-level-h }}Exceptions{{/markup/dynamic-level-h}}
111-
112-
|===
113-
| Name | Thrown on
114-
115-
{{#each allExceptions as |exception|}}
116-
| `{{exception.exception}}`
117-
| {{{exception.description}}}
118-
119-
{{/each}}
120-
|===
121-
122-
{{/if}}
123-
{{/with}}
124105
{{/if}}
125106
{{! Return value }}
126107
{{#if symbol.doc.returns}}
@@ -136,7 +117,6 @@
136117

137118
{{/if}}
138119
{{! Template Parameters }}
139-
{{#if (ne symbol.kind "overloads")}}
140120
{{#if symbol.doc.tparams}}
141121
{{#> markup/dynamic-level-h }}Template Parameters{{/markup/dynamic-level-h}}
142122

@@ -150,27 +130,8 @@
150130
{{/each}}
151131
|===
152132

153-
{{/if}}
154-
{{else}}
155-
{{#with (flattenUnique symbol.members "doc.tparams" "name") as |allTParams|}}
156-
{{#if (ne (len allTParams) 0)}}
157-
{{#> markup/dynamic-level-h }}Template Parameters{{/markup/dynamic-level-h}}
158-
159-
|===
160-
| Name | Description
161-
162-
{{#each allTParams as |param|}}
163-
| *{{param.name}}*
164-
| {{{param.description}}}
165-
166-
{{/each}}
167-
|===
168-
169-
{{/if}}
170-
{{/with}}
171133
{{/if}}
172134
{{! Parameters }}
173-
{{#if (ne symbol.kind "overloads")}}
174135
{{#if symbol.doc.params}}
175136
{{#> markup/dynamic-level-h }}Parameters{{/markup/dynamic-level-h}}
176137

@@ -184,24 +145,6 @@
184145
{{/each}}
185146
|===
186147

187-
{{/if}}
188-
{{else}}
189-
{{#with (flattenUnique symbol.members "doc.params" "name") as |allParams|}}
190-
{{#if (ne (len allParams) 0)}}
191-
{{#> markup/dynamic-level-h }}Parameters{{/markup/dynamic-level-h}}
192-
193-
|===
194-
| Name | Description
195-
196-
{{#each allParams as |param|}}
197-
| *{{param.name}}*
198-
| {{{param.description}}}
199-
200-
{{/each}}
201-
|===
202-
203-
{{/if}}
204-
{{/with}}
205148
{{/if}}
206149
{{! Preconditions }}
207150
{{#if symbol.doc.preconditions}}

‎share/mrdocs/addons/generator/common/partials/symbol/detail/members-table-row.hbs

+2-9
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,8 @@
55
{{#>markup/a href=url}}{{#>markup/code}}{{>symbol/name . nolink=true}}{{/markup/code}}{{/markup/a}} {{>symbol/special-function-suffix .}}
66
{{~/markup/td}}
77
{{#if (eq includeBrief true)}}
8-
{{#>markup/td}}
9-
{{#if (ne kind "overloads")~}}
8+
{{#>markup/td~}}
109
{{{~doc.brief}}}
11-
{{else~}}
12-
{{#each (unique (pluck (pluck members "doc") "brief"))~}}
13-
{{{.}}}
14-
15-
{{/each~}}
16-
{{/if~}}
17-
{{~/markup/td~}}
10+
{{/markup/td~}}
1811
{{/if}}
1912
{{~/markup/tr}}

‎share/mrdocs/addons/generator/common/partials/symbol/signatures.hbs

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919

2020
{{else}}
2121
{{#each members as | member |}}
22+
{{#if member.doc.brief}}{{#> markup/p }}{{{member.doc.brief}}}{{/markup/p}}{{/if}}
23+
2224
{{#> markup/code-block }}
2325
{{> symbol/signature member link=member}}
2426
{{/markup/code-block}}

‎share/mrdocs/addons/generator/html/partials/symbol.html.hbs

+1-79
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
{{! Synopsis }}
3232
{{#unless (eq symbol.kind "namespace")}}
3333
<div>
34-
{{#> markup/dynamic-level-h level=2 }}Synopsis{{/markup/dynamic-level-h}}
34+
{{#> markup/dynamic-level-h level=2 }}{{#if (ne symbol.kind "overloads")}}Synopsis{{else}}Synopses{{/if}}{{/markup/dynamic-level-h}}
3535
<div>
3636
{{>location/source dcl=(primary_location symbol)}}
3737
</div>
@@ -116,7 +116,6 @@
116116

117117
{{/if}}
118118
{{! Exceptions }}
119-
{{#if (ne symbol.kind "overloads")}}
120119
{{#if symbol.doc.exceptions}}
121120
<div>
122121
{{#> markup/dynamic-level-h level=2 }}Exceptions{{/markup/dynamic-level-h}}
@@ -138,31 +137,6 @@
138137
</table>
139138
</div>
140139
{{/if}}
141-
{{else}}
142-
{{#with (flattenUnique symbol.members "doc.exceptions" "exception") as |allExceptions|}}
143-
{{#if (ne (len allExceptions) 0)}}
144-
<div>
145-
{{#> markup/dynamic-level-h level=2 }}Exceptions{{/markup/dynamic-level-h}}
146-
<table>
147-
<thead>
148-
<tr>
149-
<th>Name</th>
150-
<th>Thrown on</th>
151-
</tr>
152-
</thead>
153-
<tbody>
154-
{{#each allExceptions as |exception|}}
155-
<tr>
156-
<td><code>{{exception}}</code></td>
157-
<td>{{{description}}}</td>
158-
</tr>
159-
{{/each}}
160-
</tbody>
161-
</table>
162-
</div>
163-
{{/if}}
164-
{{/with}}
165-
{{/if}}
166140
{{! Return value }}
167141
{{#if symbol.doc.returns}}
168142
<div>
@@ -179,7 +153,6 @@
179153
</div>
180154
{{/if}}
181155
{{! Template Parameters }}
182-
{{#if (ne symbol.kind "overloads")}}
183156
{{#if symbol.doc.tparams}}
184157
<div>
185158
{{#> markup/dynamic-level-h level=2 }}Template Parameters{{/markup/dynamic-level-h}}
@@ -201,33 +174,7 @@
201174
</table>
202175
</div>
203176
{{/if}}
204-
{{else}}
205-
{{#with (flattenUnique symbol.members "doc.tparams" "name") as |allTParams|}}
206-
{{#if (ne (len allTParams) 0)}}
207-
<div>
208-
{{#> markup/dynamic-level-h level=2 }}Template Parameters{{/markup/dynamic-level-h}}
209-
<table>
210-
<thead>
211-
<tr>
212-
<th>Name</th>
213-
<th>Description</th>
214-
</tr>
215-
</thead>
216-
<tbody>
217-
{{#each allTParams as |param|}}
218-
<tr>
219-
<td><strong>{{param.name}}</strong></td>
220-
<td>{{{param.description}}}</td>
221-
</tr>
222-
{{/each}}
223-
</tbody>
224-
</table>
225-
</div>
226-
{{/if}}
227-
{{/with}}
228-
{{/if}}
229177
{{! Parameters }}
230-
{{#if (ne symbol.kind "overloads")}}
231178
{{#if symbol.doc.params}}
232179
<div>
233180
{{#> markup/dynamic-level-h level=2 }}Parameters{{/markup/dynamic-level-h}}
@@ -249,31 +196,6 @@
249196
</table>
250197
</div>
251198
{{/if}}
252-
{{else}}
253-
{{#with (flattenUnique symbol.members "doc.params" "name") as |allParams|}}
254-
{{#if (ne (len allParams) 0)}}
255-
<div>
256-
{{#> markup/dynamic-level-h level=2 }}Parameters{{/markup/dynamic-level-h}}
257-
<table>
258-
<thead>
259-
<tr>
260-
<th>Name</th>
261-
<th>Description</th>
262-
</tr>
263-
</thead>
264-
<tbody>
265-
{{#each allParams as |param|}}
266-
<tr>
267-
<td><strong>{{param.name}}</strong></td>
268-
<td>{{{param.description}}}</td>
269-
</tr>
270-
{{/each}}
271-
</tbody>
272-
</table>
273-
</div>
274-
{{/if}}
275-
{{/with}}
276-
{{/if}}
277199
{{! Preconditions }}
278200
{{#if symbol.doc.preconditions}}
279201
<div>

‎src/lib/Lib/ConfigOptions.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@
299299
{
300300
"name": "overloads",
301301
"brief": "Detect and group function overloads",
302-
"details": "When set to `true`, MrDocs detects function overloads and groups them as a single symbol type.",
302+
"details": "When set to `true`, MrDocs detects function overloads and groups them as a single symbol type. The documentation for this new symbol comes from the union of non-ambiguous metadata from the functions.",
303303
"type": "bool",
304304
"default": true
305305
}

0 commit comments

Comments
 (0)