docs/template/tizen/partials/uref/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/uref/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-{{syntax.content.0.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><em>{{{id}}}</em></td>
  45       <td>
  46         {{{description}}}
  47         {{>partials/uref/parameters}}
  48       </td>
  49     </tr>
  50 {{/parameters}}
  51 {{#parameters.0}}
  52   </tbody>
  53 </table>
  54 {{/parameters.0}}
  55 {{#return}}
  56 <h5 class="returns">{{__global.returns}}</h5>
  57 <table class="table table-bordered table-striped table-condensed">
  58   <thead>
  59     <tr>
  60       <th>{{__global.type}}</th>
  61       <th>{{__global.description}}</th>
  62     </tr>
  63   </thead>
  64   <tbody>
  65     <tr>
  66       <td>{{{value.type.0.specName.0.value}}}</td>
  67       <td>{{{value.description}}}</td>
  68     </tr>
  69   </tbody>
  70 </table>
  71 {{/return}}
  72 {{#typeParameters.0}}
  73 <h5 class="typeParameters">{{__global.typeParameters}}</h5>
  74 <table class="table table-bordered table-striped table-condensed">
  75   <thead>
  76     <tr>
  77       <th>{{__global.name}}</th>
  78       <th>{{__global.description}}</th>
  79     </tr>
  80   </thead>
  81   <tbody>
  82 {{/typeParameters.0}}
  83 {{#typeParameters}}
  84     <tr>
  85       <td><em>{{{id}}}</em></td>
  86       <td>{{{description}}}</td>
  87     </tr>
  88 {{/typeParameters}}
  89 {{#typeParameters.0}}
  90   </tbody>
  91 </table>
  92 {{/typeParameters.0}}
  93 {{#fieldValue}}
  94 <h5 class="fieldValue">{{__global.fieldValue}}</h5>
  95 <table class="table table-bordered table-striped table-condensed">
  96   <thead>
  97     <tr>
  98       <th>{{__global.type}}</th>
  99       <th>{{__global.description}}</th>
 100     </tr>
 101   </thead>
 102   <tbody>
 103     <tr>
 104       <td>{{{value.type.0.specName.0.value}}}</td>
 105       <td>{{{value.description}}}</td>
 106     </tr>
 107   </tbody>
 108 </table>
 109 {{/fieldValue}}
 110 {{#propertyValue}}
 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>{{{value.type.0.specName.0.value}}}</td>
 122       <td>{{{value.description}}}</td>
 123     </tr>
 124   </tbody>
 125 </table>
 126 {{/propertyValue}}
 127 {{#eventType}}
 128 <h5 class="eventType">{{__global.eventType}}</h5>
 129 <table class="table table-bordered table-striped table-condensed">
 130   <thead>
 131     <tr>
 132       <th>{{__global.type}}</th>
 133       <th>{{__global.description}}</th>
 134     </tr>
 135   </thead>
 136   <tbody>
 137     <tr>
 138       <td>{{{type.specName.0.value}}}</td>
 139       <td>{{{description}}}</td>
 140     </tr>
 141   </tbody>
 142 </table>
 143 {{/eventType}}
 144 {{/syntax}}
 145 {{#overridden}}
 146 <h5 class="overrides">{{__global.overrides}}</h5>
 147 <div><xref href="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/></div>
 148 {{/overridden}}
 149 {{#implements.0}}
 150 <h5 class="implements">{{__global.implements}}</h5>
 151 {{/implements.0}}
 152 {{#implements}}
 153   {{#definition}}
 154     <div><xref href="{{definition}}" altProperty="fullName" displayProperty="nameWithType"/></div>
 155   {{/definition}}
 156   {{^definition}}
 157     <div><xref href="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/></div>
 158   {{/definition}}
 159 {{/implements}}
 160 {{#remarks}}
 161 <h5 id="{{id}}_remarks">{{__global.remarks}}</h5>
 162 <div class="markdown level1 remarks">{{{remarks}}}</div>
 163 {{/remarks}}
 164 {{#example.0}}
 165 <h5 id="{{id}}_examples">{{__global.examples}}</h5>
 166 {{/example.0}}
 167 {{#example}}
 168 {{{.}}}
 169 {{/example}}
 170 {{#exceptions.0}}
 171 <h5 class="exceptions">{{__global.exceptions}}</h5>
 172 <table class="table table-bordered table-striped table-condensed">
 173   <thead>
 174     <tr>
 175       <th>{{__global.type}}</th>
 176       <th>{{__global.condition}}</th>
 177     </tr>
 178   </thead>
 179   <tbody>
 180 {{/exceptions.0}}
 181 {{#exceptions.0.value}}
 182     <tr>
 183       <td>{{{type.specName.0.value}}}</td>
 184       <td>{{{description}}}</td>
 185     </tr>
 186 {{/exceptions.0.value}}
 187 {{#exceptions.0}}
 188   </tbody>
 189 </table>
 190 {{/exceptions.0}}
 191 {{#seealso.0}}
 192 <h5 id="{{id}}_seealso">{{__global.seealso}}</h5>
 193 <div class="seealso">
 194 {{/seealso.0}}
 195 {{#seealso}}
 196   {{#isCref}}
 197     <div>{{{type.specName.0.value}}}</div>
 198   {{/isCref}}
 199   {{^isCref}}
 200     <div>{{{url}}}</div>
 201   {{/isCref}}
 202 {{/seealso}}
 203 {{#seealso.0}}
 204 </div>
 205 {{/seealso.0}}
 206 {{/children}}
 207 {{/children}}
 208 {{#extensionMethods.0}}
 209 <h3 id="extensionmethods">{{__global.extensionMethods}}</h3>
 210 {{/extensionMethods.0}}
 211 {{#extensionMethods}}
 212 <div>
 213   {{#definition}}
 214     <xref href="{{definition}}" altProperty="fullName" displayProperty="nameWithType"/>
 215   {{/definition}}
 216   {{^definition}}
 217     <xref href="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/>
 218   {{/definition}}
 219 </div>
 220 {{/extensionMethods}}
 221 {{#seealso.0}}
 222 <h3 id="seealso">{{__global.seealso}}</h3>
 223 <div class="seealso">
 224 {{/seealso.0}}
 225 {{#seealso}}
 226   {{#isCref}}
 227     <div>{{{type.specName.0.value}}}</div>
 228   {{/isCref}}
 229   {{^isCref}}
 230     <div>{{{url}}}</div>
 231   {{/isCref}}
 232 {{/seealso}}
 233 {{#seealso.0}}
 234 </div>
 235 {{/seealso.0}}