[Docs] Fix the list in API References (#1691)
[platform/core/csapi/tizenfx.git] / docs / templates / tizen / partials / class.header.tmpl.partial
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 <h1 id="{{id}}" data-uid="{{uid}}" class="text-break">{{>partials/title}}</h1>
4 <div class="markdown level0 summary">{{{summary}}}</div>
5 <div class="markdown level0 conceptual">{{{conceptual}}}</div>
6 {{#inClass}}
7 <div class="inheritance">
8   <h5>{{__global.inheritance}}</h5>
9   {{#inheritance}}
10   <div class="level{{index}}">{{{specName.0.value}}}</div>
11   {{/inheritance}}
12   <div class="level{{level}}"><span class="xref">{{name.0.value}}</span></div>
13   {{#derivedClasses}}
14     <div class="level{{index}}">{{{specName.0.value}}}</div>
15   {{/derivedClasses}}
16 </div>
17 {{/inClass}}
18 {{#implements.0}}
19 <div classs="implements">
20   <h5>{{__global.implements}}</h5>
21 {{/implements.0}}
22 {{#implements}}
23   <div>{{{specName.0.value}}}</div>
24 {{/implements}}
25 {{#implements.0}}
26 </div>
27 {{/implements.0}}
28 {{#inheritedMembers.0}}
29 <div class="inheritedMembers">
30   <h5>{{__global.inheritedMembers}}</h5>
31 {{/inheritedMembers.0}}
32 {{#inheritedMembers}}
33   <div>
34   {{#definition}}
35     <xref uid="{{definition}}" text="{{nameWithType.0.value}}" alt="{{fullName.0.value}}"/>
36   {{/definition}}
37   {{^definition}}
38     <xref uid="{{uid}}" text="{{nameWithType.0.value}}" alt="{{fullName.0.value}}"/>
39   {{/definition}}
40   </div>
41 {{/inheritedMembers}}
42 {{#inheritedMembers.0}}
43 </div>
44 {{/inheritedMembers.0}}
45 <h6><strong>{{__global.namespace}}</strong>: {{{namespace.specName.0.value}}}</h6>
46 <h6><strong>{{__global.assembly}}</strong>: {{assemblies.0}}.dll</h6>
47 {{#sincetizen}}
48 <h6><strong>{{__global.sincetizen}}</strong>: {{{sincetizen}}}</h6>
49 {{/sincetizen}}
50 {{#privlevel}}
51 <h6><strong>{{__global.privlevel}}</strong>: {{{privlevel}}}</h6>
52 {{/privlevel}}
53 {{#privilege}}
54 <h6><strong>{{__global.privilege}}</strong>: <span class="tz_multiple_items">{{{privilege}}}</span></h6>
55 {{/privilege}}
56 {{#feature}}
57 <h6><strong>{{__global.feature}}</strong>: <span class="tz_multiple_items">{{{feature}}}</span></h6>
58 {{/feature}}
59 <h5 id="{{id}}_syntax">{{__global.syntax}}</h5>
60 <div class="codewrapper">
61   <pre><code class="lang-{{_lang}} hljs">{{syntax.content.0.value}}</code></pre>
62 </div>
63 {{#syntax.parameters.0}}
64 <h5 class="parameters">{{__global.parameters}}</h5>
65 <table class="table table-bordered table-striped table-condensed">
66   <thead>
67     <tr>
68       <th>{{__global.type}}</th>
69       <th>{{__global.name}}</th>
70       <th>{{__global.description}}</th>
71     </tr>
72   </thead>
73   <tbody>
74 {{/syntax.parameters.0}}
75 {{#syntax.parameters}}
76     <tr>
77       <td>{{{type.specName.0.value}}}</td>
78       <td><span class="parametername">{{{id}}}</span></td>
79       <td>{{{description}}}</td>
80     </tr>
81 {{/syntax.parameters}}
82 {{#syntax.parameters.0}}
83   </tbody>
84 </table>
85 {{/syntax.parameters.0}}
86 {{#syntax.return}}
87 <h5 class="returns">{{__global.returns}}</h5>
88 <table class="table table-bordered table-striped table-condensed">
89   <thead>
90     <tr>
91       <th>{{__global.type}}</th>
92       <th>{{__global.description}}</th>
93     </tr>
94   </thead>
95   <tbody>
96     <tr>
97       <td>{{{type.specName.0.value}}}</td>
98       <td>{{{description}}}</td>
99     </tr>
100   </tbody>
101 </table>
102 {{/syntax.return}}
103 {{#syntax.typeParameters.0}}
104 <h5 class="typeParameters">{{__global.typeParameters}}</h5>
105 <table class="table table-bordered table-striped table-condensed">
106   <thead>
107     <tr>
108       <th>{{__global.name}}</th>
109       <th>{{__global.description}}</th>
110     </tr>
111   </thead>
112   <tbody>
113 {{/syntax.typeParameters.0}}
114 {{#syntax.typeParameters}}
115     <tr>
116       <td><span class="parametername">{{{id}}}</span></td>
117       <td>{{{description}}}</td>
118     </tr>
119 {{/syntax.typeParameters}}
120 {{#syntax.typeParameters.0}}
121   </tbody>
122 </table>
123 {{/syntax.typeParameters.0}}
124 {{#remarks}}
125 <h5 id="{{id}}_remarks"><strong>{{__global.remarks}}</strong></h5>
126 <div class="markdown level0 remarks">{{{remarks}}}</div>
127 {{/remarks}}
128 {{#example.0}}
129 <h5 id="{{id}}_examples"><strong>{{__global.examples}}</strong></h5>
130 {{/example.0}}
131 {{#example}}
132 {{{.}}}
133 {{/example}}