docs/template/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 <h5 id="{{id}}_syntax">{{__global.syntax}}</h5>
  48 <div class="codewrapper">
  49   <pre><code class="lang-{{_lang}} hljs">{{syntax.content.0.value}}</code></pre>
  50 </div>
  51 {{#syntax.parameters.0}}
  52 <h5 class="parameters">{{__global.parameters}}</h5>
  53 <table class="table table-bordered table-striped table-condensed">
  54   <thead>
  55     <tr>
  56       <th>{{__global.type}}</th>
  57       <th>{{__global.name}}</th>
  58       <th>{{__global.description}}</th>
  59     </tr>
  60   </thead>
  61   <tbody>
  62 {{/syntax.parameters.0}}
  63 {{#syntax.parameters}}
  64     <tr>
  65       <td>{{{type.specName.0.value}}}</td>
  66       <td><span class="parametername">{{{id}}}</span></td>
  67       <td>{{{description}}}</td>
  68     </tr>
  69 {{/syntax.parameters}}
  70 {{#syntax.parameters.0}}
  71   </tbody>
  72 </table>
  73 {{/syntax.parameters.0}}
  74 {{#syntax.return}}
  75 <h5 class="returns">{{__global.returns}}</h5>
  76 <table class="table table-bordered table-striped table-condensed">
  77   <thead>
  78     <tr>
  79       <th>{{__global.type}}</th>
  80       <th>{{__global.description}}</th>
  81     </tr>
  82   </thead>
  83   <tbody>
  84     <tr>
  85       <td>{{{type.specName.0.value}}}</td>
  86       <td>{{{description}}}</td>
  87     </tr>
  88   </tbody>
  89 </table>
  90 {{/syntax.return}}
  91 {{#syntax.typeParameters.0}}
  92 <h5 class="typeParameters">{{__global.typeParameters}}</h5>
  93 <table class="table table-bordered table-striped table-condensed">
  94   <thead>
  95     <tr>
  96       <th>{{__global.name}}</th>
  97       <th>{{__global.description}}</th>
  98     </tr>
  99   </thead>
 100   <tbody>
 101 {{/syntax.typeParameters.0}}
 102 {{#syntax.typeParameters}}
 103     <tr>
 104       <td><span class="parametername">{{{id}}}</span></td>
 105       <td>{{{description}}}</td>
 106     </tr>
 107 {{/syntax.typeParameters}}
 108 {{#syntax.typeParameters.0}}
 109   </tbody>
 110 </table>
 111 {{/syntax.typeParameters.0}}
 112 {{#remarks}}
 113 <h5 id="{{id}}_remarks"><strong>{{__global.remarks}}</strong></h5>
 114 <div class="markdown level0 remarks">{{{remarks}}}</div>
 115 {{/remarks}}
 116
 117 {{#sincetizen}}
 118 <h5 id="{{id}}_sincetizen" class="sincetizen">{{__global.sincetizen}}</h5>
 119 <span class="level0 sincetizen">{{{sincetizen}}}</span>
 120 {{/sincetizen}}
 121 {{#privlevel}}
 122 <h5 id="{{id}}_privlevel" class="privlevel">{{__global.privlevel}}</h5>
 123 <div class="markdown level0 privlevel">{{{privlevel}}}</div>
 124 {{/privlevel}}
 125 {{#privilege}}
 126 <h5 id="{{id}}_privilege" class="privilege">{{__global.privilege}}</h5>
 127 <div class="markdown level0 privilege">{{{privilege}}}</div>
 128 {{/privilege}}
 129 {{#feature}}
 130 <h5 id="{{id}}_feature" class="feature">{{__global.feature}}</h5>
 131 <div class="markdown level0 feature">{{{feature}}}</div>
 132 {{/feature}}
 133
 134 {{#example.0}}
 135 <h5 id="{{id}}_examples"><strong>{{__global.examples}}</strong></h5>
 136 {{/example.0}}
 137 {{#example}}
 138 {{{.}}}
 139 {{/example}}