Skip to content

Commit 1a9c322

Browse files
adamgrahamadamgraham
committed
Exclude field and property values with no description
1 parent 8b06e2d commit 1a9c322

File tree

1 file changed

+238
-0
lines changed

1 file changed

+238
-0
lines changed

‎.docfx/templates/zigurous/partials/class.tmpl.partial‎

Lines changed: 238 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,238 @@
1+
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
2+
3+
{{>partials/class.header}}
4+
{{#children}}
5+
<h3 id="{{id}}">{{>partials/classSubtitle}}</h3>
6+
{{#children}}
7+
{{^_disableContribution}}
8+
{{#docurl}}
9+
<span class="small pull-right mobile-hide">
10+
<span class="divider">|</span>
11+
<a href="{{docurl}}">{{__global.improveThisDoc}}</a>
12+
</span>{{/docurl}}
13+
{{#sourceurl}}
14+
<span class="small pull-right mobile-hide">
15+
<a href="{{sourceurl}}">{{__global.viewSource}}</a>
16+
</span>{{/sourceurl}}
17+
{{/_disableContribution}}
18+
{{#overload}}
19+
<a id="{{id}}" data-uid="{{uid}}"></a>
20+
{{/overload}}
21+
<h4 id="{{id}}" data-uid="{{uid}}">{{name.0.value}}</h4>
22+
<div class="markdown level1 summary">{{{summary}}}</div>
23+
<div class="markdown level1 conceptual">{{{conceptual}}}</div>
24+
<h5 class="decalaration">{{__global.declaration}}</h5>
25+
{{#syntax}}
26+
<div class="codewrapper">
27+
<pre><code class="lang-{{_lang}} hljs">{{syntax.content.0.value}}</code></pre>
28+
</div>
29+
{{#parameters.0}}
30+
<h5 class="parameters">{{__global.parameters}}</h5>
31+
<table class="table table-bordered table-striped table-condensed">
32+
<thead>
33+
<tr>
34+
<th>{{__global.type}}</th>
35+
<th>{{__global.name}}</th>
36+
<th>{{__global.description}}</th>
37+
</tr>
38+
</thead>
39+
<tbody>
40+
{{/parameters.0}}
41+
{{#parameters}}
42+
<tr>
43+
<td>{{{type.specName.0.value}}}</td>
44+
<td><span class="parametername">{{{id}}}</span></td>
45+
<td>{{{description}}}</td>
46+
</tr>
47+
{{/parameters}}
48+
{{#parameters.0}}
49+
</tbody>
50+
</table>
51+
{{/parameters.0}}
52+
{{#return}}
53+
<h5 class="returns">{{__global.returns}}</h5>
54+
<table class="table table-bordered table-striped table-condensed">
55+
<thead>
56+
<tr>
57+
<th>{{__global.type}}</th>
58+
<th>{{__global.description}}</th>
59+
</tr>
60+
</thead>
61+
<tbody>
62+
<tr>
63+
<td>{{{type.specName.0.value}}}</td>
64+
<td>{{{description}}}</td>
65+
</tr>
66+
</tbody>
67+
</table>
68+
{{/return}}
69+
{{#typeParameters.0}}
70+
<h5 class="typeParameters">{{__global.typeParameters}}</h5>
71+
<table class="table table-bordered table-striped table-condensed">
72+
<thead>
73+
<tr>
74+
<th>{{__global.name}}</th>
75+
<th>{{__global.description}}</th>
76+
</tr>
77+
</thead>
78+
<tbody>
79+
{{/typeParameters.0}}
80+
{{#typeParameters}}
81+
<tr>
82+
<td><span class="parametername">{{{id}}}</span></td>
83+
<td>{{{description}}}</td>
84+
</tr>
85+
{{/typeParameters}}
86+
{{#typeParameters.0}}
87+
</tbody>
88+
</table>
89+
{{/typeParameters.0}}
90+
{{#fieldValue}}
91+
{{#description}}
92+
<h5 class="fieldValue">{{__global.fieldValue}}</h5>
93+
<table class="table table-bordered table-striped table-condensed">
94+
<thead>
95+
<tr>
96+
<th>{{__global.type}}</th>
97+
<th>{{__global.description}}</th>
98+
</tr>
99+
</thead>
100+
<tbody>
101+
<tr>
102+
<td>{{{type.specName.0.value}}}</td>
103+
<td>{{{description}}}</td>
104+
</tr>
105+
</tbody>
106+
</table>
107+
{{/description}}
108+
{{/fieldValue}}
109+
{{#propertyValue}}
110+
{{#description}}
111+
<h5 class="propertyValue">{{__global.propertyValue}}</h5>
112+
<table class="table table-bordered table-striped table-condensed">
113+
<thead>
114+
<tr>
115+
<th>{{__global.type}}</th>
116+
<th>{{__global.description}}</th>
117+
</tr>
118+
</thead>
119+
<tbody>
120+
<tr>
121+
<td>{{{type.specName.0.value}}}</td>
122+
<td>{{{description}}}</td>
123+
</tr>
124+
</tbody>
125+
</table>
126+
{{/description}}
127+
{{/propertyValue}}
128+
{{#eventType}}
129+
<h5 class="eventType">{{__global.eventType}}</h5>
130+
<table class="table table-bordered table-striped table-condensed">
131+
<thead>
132+
<tr>
133+
<th>{{__global.type}}</th>
134+
<th>{{__global.description}}</th>
135+
</tr>
136+
</thead>
137+
<tbody>
138+
<tr>
139+
<td>{{{type.specName.0.value}}}</td>
140+
<td>{{{description}}}</td>
141+
</tr>
142+
</tbody>
143+
</table>
144+
{{/eventType}}
145+
{{/syntax}}
146+
{{#overridden}}
147+
<h5 class="overrides">{{__global.overrides}}</h5>
148+
<div><xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/></div>
149+
{{/overridden}}
150+
{{#remarks}}
151+
<h5 id="{{id}}_remarks">{{__global.remarks}}</h5>
152+
<div class="markdown level1 remarks">{{{remarks}}}</div>
153+
{{/remarks}}
154+
{{#example.0}}
155+
<h5 id="{{id}}_examples">{{__global.examples}}</h5>
156+
{{/example.0}}
157+
{{#example}}
158+
{{{.}}}
159+
{{/example}}
160+
{{#exceptions.0}}
161+
<h5 class="exceptions">{{__global.exceptions}}</h5>
162+
<table class="table table-bordered table-striped table-condensed">
163+
<thead>
164+
<tr>
165+
<th>{{__global.type}}</th>
166+
<th>{{__global.condition}}</th>
167+
</tr>
168+
</thead>
169+
<tbody>
170+
{{/exceptions.0}}
171+
{{#exceptions}}
172+
<tr>
173+
<td>{{{type.specName.0.value}}}</td>
174+
<td>{{{description}}}</td>
175+
</tr>
176+
{{/exceptions}}
177+
{{#exceptions.0}}
178+
</tbody>
179+
</table>
180+
{{/exceptions.0}}
181+
{{#seealso.0}}
182+
<h5 id="{{id}}_seealso">{{__global.seealso}}</h5>
183+
<div class="seealso">
184+
{{/seealso.0}}
185+
{{#seealso}}
186+
{{#isCref}}
187+
<div>{{{type.specName.0.value}}}</div>
188+
{{/isCref}}
189+
{{^isCref}}
190+
<div>{{{url}}}</div>
191+
{{/isCref}}
192+
{{/seealso}}
193+
{{#seealso.0}}
194+
</div>
195+
{{/seealso.0}}
196+
{{/children}}
197+
{{/children}}
198+
{{#implements.0}}
199+
<h3 id="implements">{{__global.implements}}</h3>
200+
{{/implements.0}}
201+
{{#implements}}
202+
<div>
203+
{{#definition}}
204+
<xref uid="{{definition}}" altProperty="fullName" displayProperty="nameWithType"/>
205+
{{/definition}}
206+
{{^definition}}
207+
<xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/>
208+
{{/definition}}
209+
</div>
210+
{{/implements}}
211+
{{#extensionMethods.0}}
212+
<h3 id="extensionmethods">{{__global.extensionMethods}}</h3>
213+
{{/extensionMethods.0}}
214+
{{#extensionMethods}}
215+
<div>
216+
{{#definition}}
217+
<xref uid="{{definition}}" altProperty="fullName" displayProperty="nameWithType"/>
218+
{{/definition}}
219+
{{^definition}}
220+
<xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/>
221+
{{/definition}}
222+
</div>
223+
{{/extensionMethods}}
224+
{{#seealso.0}}
225+
<h3 id="seealso">{{__global.seealso}}</h3>
226+
<div class="seealso">
227+
{{/seealso.0}}
228+
{{#seealso}}
229+
{{#isCref}}
230+
<div>{{{type.specName.0.value}}}</div>
231+
{{/isCref}}
232+
{{^isCref}}
233+
<div>{{{url}}}</div>
234+
{{/isCref}}
235+
{{/seealso}}
236+
{{#seealso.0}}
237+
</div>
238+
{{/seealso.0}}

0 commit comments

Comments
 (0)