...

Text file src/github.com/Azure/azure-sdk-for-go/eng/common/docgeneration/templates/matthews/partials/class.header.tmpl.partial

Documentation: github.com/Azure/azure-sdk-for-go/eng/common/docgeneration/templates/matthews/partials

     1<h1 id="{{id}}" data-uid="{{uid}}">{{>partials/title}}</h1>
     2<div class="markdown level0 summary">{{{summary}}}</div>
     3<div class="markdown level0 conceptual">{{{conceptual}}}</div>
     4
     5{{#inClass}}
     6<div class="inheritance">
     7  <h5>{{__global.inheritance}}</h5>
     8  {{#inheritance}}
     9  <div class="level{{index}}">{{{specName.0.value}}}</div>
    10  {{/inheritance}}
    11  <div class="level{{level}}"><span class="xref">{{name.0.value}}</span></div>
    12</div>
    13{{/inClass}}
    14
    15{{#derivedClasses}}
    16    <div class="level{{index}}">{{{specName.0.value}}}</div>
    17{{/derivedClasses}}
    18
    19{{#inheritedMembers.0}}
    20<div class="inheritedMembers">
    21  <h5>{{__global.inheritedMembers}}</h5>
    22{{/inheritedMembers.0}}
    23{{#inheritedMembers}}
    24  <div>
    25  {{#definition}}
    26    <xref uid="{{definition}}" text="{{nameWithType.0.value}}" alt="{{fullName.0.value}}"/>
    27  {{/definition}}
    28  {{^definition}}
    29    <xref uid="{{uid}}" text="{{nameWithType.0.value}}" alt="{{fullName.0.value}}"/>
    30  {{/definition}}
    31  </div>
    32{{/inheritedMembers}}
    33{{#inheritedMembers.0}}
    34</div>
    35{{/inheritedMembers.0}}
    36
    37<h6><strong>{{__global.namespace}}</strong>: {{namespace}}</h6>
    38<h6><strong>{{__global.assembly}}</strong>: {{assemblies.0}}.dll</h6>
    39
    40<h5 id="{{id}}_syntax">{{__global.syntax}}</h5>
    41<div class="codewrapper">
    42  <pre><code class="lang-{{_lang}} hljs">{{syntax.content.0.value}}</code></pre>
    43</div>
    44
    45{{#syntax.parameters.0}}
    46<h5 class="parameters">{{__global.parameters}}</h5>
    47<table>
    48{{/syntax.parameters.0}}
    49{{#syntax.parameters}}
    50  <tr>
    51    <td>
    52      <span class="pull-right">{{{type.specName.0.value}}}</span>
    53      <span class="parametername">{{{id}}}</span>
    54      <p>{{{description}}}</p>
    55    </td>
    56  </tr>
    57{{/syntax.parameters}}
    58{{#syntax.parameters.0}}
    59</table>
    60{{/syntax.parameters.0}}
    61
    62{{#syntax.return}}
    63<h5 class="returns">{{__global.returns}}</h5>
    64<table>
    65  <tr>
    66    <td>
    67      {{{type.specName.0.value}}}
    68      <p>{{{description}}}</p>
    69    </td>
    70  </tr>
    71</table>
    72{{/syntax.return}}
    73
    74{{#syntax.typeParameters.0}}
    75<h5 class="typeParameters">{{__global.typeParameters}}</h5>
    76<table>
    77{{/syntax.typeParameters.0}}
    78{{#syntax.typeParameters}}
    79  <tr>
    80    <td>
    81      <span class="parametername">{{{id}}}</span>
    82      <p>{{{description}}}</p>
    83    </td>
    84  </tr>
    85{{/syntax.typeParameters}}
    86{{#syntax.typeParameters.0}}
    87</table>
    88{{/syntax.typeParameters.0}}
    89
    90{{#remarks}}
    91<h5 id="{{id}}_remarks"><strong>{{__global.remarks}}</strong></h5>
    92<div class="markdown level0 remarks">{{{remarks}}}</div>
    93{{/remarks}}
    94
    95{{#example.0}}
    96<h5 id="{{id}}_examples"><strong>{{__global.examples}}</strong></h5>
    97{{/example.0}}
    98{{#example}}
    99{{{.}}}
   100{{/example}}

View as plain text