Skip to content

Commit e42f456

Browse files
BlizzCrafterBlizzCrafter
committed
Update docs.
1 parent 25f449a commit e42f456

File tree

2 files changed

+123
-61
lines changed

2 files changed

+123
-61
lines changed

‎templates/monogo/partials/class.header.tmpl.partial‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
2+
3+
<table>
4+
<tr>
5+
<th><h6><strong>{{__global.namespace}}</strong>: {{{namespace.specName.0.value}}}</h6></th>
6+
<th><h6><strong>{{__global.assembly}}</strong>: {{assemblies.0}}.dll</h6></th>
7+
</tr>
8+
</table>
9+
10+
<h1 id="{{id}}" data-uid="{{uid}}" class="text-break">{{>partials/title}}</h1>
11+
<div class="markdown level0 summary">{{{summary}}}</div>
12+
<div class="markdown level0 conceptual">{{{conceptual}}}</div>
13+
<h5 id="{{id}}_syntax">{{__global.syntax}}</h5>
14+
<div class="codewrapper">
15+
<pre><code class="lang-csharp hljs">{{syntax.content.0.value}}</code></pre>
16+
</div>
17+
{{#syntax.parameters.0}}
18+
<h5 class="parameters">{{__global.parameters}}</h5>
19+
<table class="table table-bordered table-condensed">
20+
<thead>
21+
<tr>
22+
<th>{{__global.type}}</th>
23+
<th>{{__global.name}}</th>
24+
<th>{{__global.description}}</th>
25+
</tr>
26+
</thead>
27+
<tbody>
28+
{{/syntax.parameters.0}}
29+
{{#syntax.parameters}}
30+
<tr>
31+
<td>{{{type.specName.0.value}}}</td>
32+
<td><span class="parametername">{{{id}}}</span></td>
33+
<td>{{{description}}}</td>
34+
</tr>
35+
{{/syntax.parameters}}
36+
{{#syntax.parameters.0}}
37+
</tbody>
38+
</table>
39+
{{/syntax.parameters.0}}
40+
{{#syntax.return}}
41+
<h5 class="returns">{{__global.returns}}</h5>
42+
<table class="table table-bordered table-condensed">
43+
<thead>
44+
<tr>
45+
<th>{{__global.type}}</th>
46+
<th>{{__global.description}}</th>
47+
</tr>
48+
</thead>
49+
<tbody>
50+
<tr>
51+
<td>{{{type.specName.0.value}}}</td>
52+
<td>{{{description}}}</td>
53+
</tr>
54+
</tbody>
55+
</table>
56+
{{/syntax.return}}
57+
{{#syntax.typeParameters.0}}
58+
<h5 class="typeParameters">{{__global.typeParameters}}</h5>
59+
<table class="table table-bordered table-condensed">
60+
<thead>
61+
<tr>
62+
<th>{{__global.name}}</th>
63+
<th>{{__global.description}}</th>
64+
</tr>
65+
</thead>
66+
<tbody>
67+
{{/syntax.typeParameters.0}}
68+
{{#syntax.typeParameters}}
69+
<tr>
70+
<td><span class="parametername">{{{id}}}</span></td>
71+
<td>{{{description}}}</td>
72+
</tr>
73+
{{/syntax.typeParameters}}
74+
{{#syntax.typeParameters.0}}
75+
</tbody>
76+
</table>
77+
{{/syntax.typeParameters.0}}
78+
{{#remarks}}
79+
<h5 id="{{id}}_remarks"><strong>{{__global.remarks}}</strong></h5>
80+
<div class="markdown level0 remarks">{{{remarks}}}</div>
81+
{{/remarks}}
82+
{{#example.0}}
83+
<h5 id="{{id}}_examples"><strong>{{__global.examples}}</strong></h5>
84+
{{/example.0}}
85+
{{#example}}
86+
{{{.}}}
87+
{{/example}}

‎templates/monogo/partials/class.tmpl.partial‎

Lines changed: 36 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -14,74 +14,66 @@
1414
<a id="{{id}}" data-uid="{{uid}}"></a>
1515
{{/overload}}
1616

17-
<h3 id="{{id}}" data-uid="{{uid}}">
18-
{{name.0.value}}
19-
{{#sourceurl}}<a class="header-action link-secondary" title="View source" href="{{sourceurl}}"><i class="bi bi-code-slash"></i></a>{{/sourceurl}}
20-
</h3>
21-
22-
<div class="markdown level1 summary">{{{summary}}}</div>
23-
<div class="markdown level1 conceptual">{{{conceptual}}}</div>
24-
25-
{{#syntax}}
26-
<div class="codewrapper">
17+
<table style="table-layout:fixed !important; width:100% !important; margin-bottom:0px !important;">
18+
<tbody">
19+
<tr>
20+
<td style="width:5%; text-align: center; vertical-align: middle;">
21+
<h5 id="{{id}}" data-uid="{{uid}}">
22+
{{#sourceurl}}<a class="link-secondary" title="View source" href="{{sourceurl}}"><i class="bi bi-code-slash"></i></a>{{/sourceurl}}
23+
</h5></td>
24+
<td style="width:50%; vertical-align:middle;">
25+
<div class="markdown level1 conceptual">{{{conceptual}}}</div>
26+
<div id="{{id}}" data-uid="{{uid}}">{{#syntax}}</div>
27+
<div class="codewrapper">
2728
<pre><code class="lang-csharp hljs">{{syntax.content.0.value}}</code></pre>
2829
</div>
29-
30-
{{#syntax.parameters.0}}
31-
<h4 class="section">{{__global.parameters}}</h4>
32-
<dl class="parameters">
33-
{{/syntax.parameters.0}}
34-
{{#syntax.parameters}}
35-
<dt><code>{{{id}}}</code> {{{type.specName.0.value}}}</dt>
36-
<dd>{{{description}}}</dd>
37-
{{/syntax.parameters}}
38-
{{#syntax.parameters.0}}
39-
</dl>
40-
{{/syntax.parameters.0}}
41-
42-
{{#syntax.return}}
43-
<h4 class="section">{{__global.returns}}</h4>
30+
{{#exceptions.0}}
4431
<dl class="parameters">
32+
{{/exceptions.0}}
33+
{{#exceptions}}
4534
<dt>{{{type.specName.0.value}}}</dt>
4635
<dd>{{{description}}}</dd>
36+
{{/exceptions}}
37+
{{#exceptions.0}}
4738
</dl>
48-
{{/syntax.return}}
49-
50-
{{#syntax.typeParameters.0}}
51-
<h4 class="section">{{__global.typeParameters}}</h4>
52-
<dl class="parameters">
53-
{{/syntax.typeParameters.0}}
54-
{{#syntax.typeParameters}}
55-
<dt><code>{{{id}}}</code></dt>
56-
<dd>{{{description}}}</dd>
57-
{{/syntax.typeParameters}}
58-
{{#syntax.typeParameters.0}}
59-
</dl>
60-
{{/syntax.typeParameters.0}}
61-
39+
{{/exceptions.0}}
40+
</td>
41+
<td style="width:25%; vertical-align:middle;">
42+
<div class="markdown level1 summary">{{{summary}}}</div>
43+
{{#remarks}}
44+
<h4 class="section" id="{{id}}_remarks">{{__global.remarks}}</h4>
45+
<div class="markdown level1 remarks">{{{remarks}}}</div>
46+
{{/remarks}}
47+
</td>
48+
<td style="width:20%; text-align: center; vertical-align: middle;">
6249
{{#fieldValue}}
63-
<h4 class="section">{{__global.fieldValue}}</h4>
6450
<dl class="parameters">
6551
<dt>{{{type.specName.0.value}}}</dt>
6652
<dd>{{{description}}}</dd>
6753
</dl>
6854
{{/fieldValue}}
69-
7055
{{#propertyValue}}
71-
<h4 class="section">{{__global.propertyValue}}</h4>
7256
<dl class="parameters">
7357
<dt>{{{type.specName.0.value}}}</dt>
7458
<dd>{{{description}}}</dd>
7559
</dl>
7660
{{/propertyValue}}
77-
61+
{{#syntax.return}}
62+
<dl class="parameters">
63+
<dt>{{{type.specName.0.value}}}</dt>
64+
<dd>{{{description}}}</dd>
65+
</dl>
66+
{{/syntax.return}}
7867
{{#eventType}}
79-
<h4 class="section">{{__global.eventType}}</h4>
8068
<dl class="parameters">
8169
<dt>{{{type.specName.0.value}}}</dt>
8270
<dd>{{{description}}}</dd>
8371
</dl>
8472
{{/eventType}}
73+
</td>
74+
</tr>
75+
</tbody>
76+
</table>
8577

8678
{{/syntax}}
8779

@@ -92,23 +84,6 @@
9284
{{{.}}}
9385
{{/example}}
9486

95-
{{#remarks}}
96-
<h4 class="section" id="{{id}}_remarks">{{__global.remarks}}</h4>
97-
<div class="markdown level1 remarks">{{{remarks}}}</div>
98-
{{/remarks}}
99-
100-
{{#exceptions.0}}
101-
<h4 class="section">{{__global.exceptions}}</h4>
102-
<dl class="parameters">
103-
{{/exceptions.0}}
104-
{{#exceptions}}
105-
<dt>{{{type.specName.0.value}}}</dt>
106-
<dd>{{{description}}}</dd>
107-
{{/exceptions}}
108-
{{#exceptions.0}}
109-
</dl>
110-
{{/exceptions.0}}
111-
11287
{{#seealso.0}}
11388
<dl class="typelist seealso">
11489
<dt>{{__global.seealso}}</dt>

0 commit comments

Comments
 (0)