docs/template/tizen/partials/class.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 {{>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 <h5 class="fieldValue">{{__global.fieldValue}}</h5>
  92 <table class="table table-bordered table-striped table-condensed">
  93   <thead>
  94     <tr>
  95       <th>{{__global.type}}</th>
  96       <th>{{__global.description}}</th>
  97     </tr>
  98   </thead>
  99   <tbody>
 100     <tr>
 101       <td>{{{type.specName.0.value}}}</td>
 102       <td>{{{description}}}</td>
 103     </tr>
 104   </tbody>
 105 </table>
 106 {{/fieldValue}}
 107 {{#propertyValue}}
 108 <h5 class="propertyValue">{{__global.propertyValue}}</h5>
 109 <table class="table table-bordered table-striped table-condensed">
 110   <thead>
 111     <tr>
 112       <th>{{__global.type}}</th>
 113       <th>{{__global.description}}</th>
 114     </tr>
 115   </thead>
 116   <tbody>
 117     <tr>
 118       <td>{{{type.specName.0.value}}}</td>
 119       <td>{{{description}}}</td>
 120     </tr>
 121   </tbody>
 122 </table>
 123 {{/propertyValue}}
 124 {{#eventType}}
 125 <h5 class="eventType">{{__global.eventType}}</h5>
 126 <table class="table table-bordered table-striped table-condensed">
 127   <thead>
 128     <tr>
 129       <th>{{__global.type}}</th>
 130       <th>{{__global.description}}</th>
 131     </tr>
 132   </thead>
 133   <tbody>
 134     <tr>
 135       <td>{{{type.specName.0.value}}}</td>
 136       <td>{{{description}}}</td>
 137     </tr>
 138   </tbody>
 139 </table>
 140 {{/eventType}}
 141 {{/syntax}}
 142 {{#overridden}}
 143 <h5 class="overrides">{{__global.overrides}}</h5>
 144 <div><xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/></div>
 145 {{/overridden}}
 146 {{#implements.0}}
 147 <h5 class="implements">{{__global.implements}}</h5>
 148 {{/implements.0}}
 149 {{#implements}}
 150   {{#definition}}
 151     <div><xref uid="{{definition}}" altProperty="fullName" displayProperty="nameWithType"/></div>
 152   {{/definition}}
 153   {{^definition}}
 154     <div><xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/></div>
 155   {{/definition}}
 156 {{/implements}}
 157 {{#remarks}}
 158 <h5 id="{{id}}_remarks">{{__global.remarks}}</h5>
 159 <div class="markdown level1 remarks">{{{remarks}}}</div>
 160 {{/remarks}}
 161
 162 {{#sinceTizen}}
 163 <h5 id="{{id}}_sinceTizen" class="sinceTizen">{{__global.sinceTizen}}</h5>
 164 <span class="level1 sinceTizen">{{{sinceTizen}}}</span>
 165 {{/sinceTizen}}
 166 {{#pre}}
 167 <h5 id="{{id}}_pre" class="preconditions">{{__global.pre}}</h5>
 168 <div class="markdown level1 preconditions">{{{pre}}}</div>
 169 {{/pre}}
 170 {{#post}}
 171 <h5 id="{{id}}_post" class="postconditions">{{__global.post}}</h5>
 172 <div class="markdown level1 postconditions">{{{post}}}</div>
 173 {{/post}}
 174 {{#privlevel}}
 175 <h5 id="{{id}}_privlevel" class="privlevel">{{__global.privlevel}}</h5>
 176 <span class="markdown level1 privlevel">{{{privlevel}}}</span>
 177 {{/privlevel}}
 178 {{#privilege}}
 179 <h5 id="{{id}}_privilege" class="privilege">{{__global.privilege}}</h5>
 180 <div class="markdown level1 privilege">{{{privilege}}}</div>
 181 {{/privilege}}
 182 {{#feature}}
 183 <h5 id="{{id}}_feature" class="feature">{{__global.feature}}</h5>
 184 <div class="markdown level1 feature">{{{feature}}}</div>
 185 {{/feature}}
 186
 187 {{#example.0}}
 188 <h5 id="{{id}}_examples">{{__global.examples}}</h5>
 189 {{/example.0}}
 190 {{#example}}
 191 {{{.}}}
 192 {{/example}}
 193 {{#exceptions.0}}
 194 <h5 class="exceptions">{{__global.exceptions}}</h5>
 195 <table class="table table-bordered table-striped table-condensed">
 196   <thead>
 197     <tr>
 198       <th>{{__global.type}}</th>
 199       <th>{{__global.condition}}</th>
 200     </tr>
 201   </thead>
 202   <tbody>
 203 {{/exceptions.0}}
 204 {{#exceptions}}
 205     <tr>
 206       <td>{{{type.specName.0.value}}}</td>
 207       <td>{{{description}}}</td>
 208     </tr>
 209 {{/exceptions}}
 210 {{#exceptions.0}}
 211   </tbody>
 212 </table>
 213 {{/exceptions.0}}
 214 {{#seealso.0}}
 215 <h5 id="{{id}}_seealso">{{__global.seealso}}</h5>
 216 <div class="seealso">
 217 {{/seealso.0}}
 218 {{#seealso}}
 219   {{#isCref}}
 220     <div>{{{type.specName.0.value}}}</div>
 221   {{/isCref}}
 222   {{^isCref}}
 223     <div>{{{url}}}</div>
 224   {{/isCref}}
 225 {{/seealso}}
 226 {{#seealso.0}}
 227 </div>
 228 {{/seealso.0}}
 229 {{/children}}
 230 {{/children}}
 231 {{#extensionMethods.0}}
 232 <h3 id="extensionmethods">{{__global.extensionMethods}}</h3>
 233 {{/extensionMethods.0}}
 234 {{#extensionMethods}}
 235 <div>
 236   {{#definition}}
 237     <xref uid="{{definition}}" altProperty="fullName" displayProperty="nameWithType"/>
 238   {{/definition}}
 239   {{^definition}}
 240     <xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/>
 241   {{/definition}}
 242 </div>
 243 {{/extensionMethods}}
 244 {{#seealso.0}}
 245 <h3 id="seealso">{{__global.seealso}}</h3>
 246 <div class="seealso">
 247 {{/seealso.0}}
 248 {{#seealso}}
 249   {{#isCref}}
 250     <div>{{{type.specName.0.value}}}</div>
 251   {{/isCref}}
 252   {{^isCref}}
 253     <div>{{{url}}}</div>
 254   {{/isCref}}
 255 {{/seealso}}
 256 {{#seealso.0}}
 257 </div>
 258 {{/seealso.0}}