...

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

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

     1{{>partials/class.header}}
     2{{#children}}
     3<h3 id="{{id}}">{{>partials/classSubtitle}}</h3>
     4{{#children}}
     5
     6{{^_disableContribution}}
     7{{#docurl}}
     8<span class="small pull-right mobile-hide">
     9  <span class="divider"> </span>
    10  <a href="{{docurl}}" title="{{__global.improveThisDoc}}"><i class="fa fa-pencil"></i></a>
    11</span>
    12{{/docurl}}
    13{{#sourceurl}}
    14<span class="small pull-right mobile-hide">
    15  <a href="{{sourceurl}}" title="{{__global.viewSource}}"><i class="fa fa-code"></i></a>
    16</span>
    17{{/sourceurl}}
    18{{/_disableContribution}}
    19
    20{{#overload}}
    21<a id="{{id}}" data-uid="{{uid}}"></a>
    22{{/overload}}
    23
    24<h4 id="{{id}}" data-uid="{{uid}}"><a href="#collapsible-{{id}}" class="expander" data-toggle="collapse">{{name.0.value}}</a></h4>
    25
    26<div id="collapsible-{{id}}" class="collapse in">
    27<div class="markdown level1 summary">{{{summary}}}</div>
    28<div class="markdown level1 conceptual">{{{conceptual}}}</div>
    29<h5 class="decalaration">{{__global.declaration}}</h5>
    30
    31{{#syntax}}
    32<div class="codewrapper">
    33  <pre><code class="lang-{{_lang}} hljs">{{syntax.content.0.value}}</code></pre>
    34</div>
    35
    36{{#parameters.0}}
    37<h5 class="parameters">{{__global.parameters}}</h5>
    38<table>
    39{{/parameters.0}}
    40{{#parameters}}
    41  <tr>
    42    <td>
    43      <span class="pull-right">{{{type.specName.0.value}}}</span>
    44      <span class="parametername">{{{id}}}</span>
    45      <p>{{{description}}}</p>
    46    </td>
    47  </tr>
    48{{/parameters}}
    49{{#parameters.0}}
    50</table>
    51{{/parameters.0}}
    52
    53{{#return}}
    54<h5 class="returns">{{__global.returns}}</h5>
    55<table>
    56  <tr>
    57    <td>
    58      {{{type.specName.0.value}}}
    59      <p>{{{description}}}</p>
    60    </td>
    61  </tr>
    62</table>
    63{{/return}}
    64
    65{{#typeParameters.0}}
    66<h5 class="typeParameters">{{__global.typeParameters}}</h5>
    67<table>
    68{{/typeParameters.0}}
    69{{#typeParameters}}
    70  <tr>
    71    <td>
    72      <span class="parametername">{{{id}}}</span>
    73      <p>{{{description}}}</p>
    74    </td>
    75  </tr>
    76{{/typeParameters}}
    77{{#typeParameters.0}}
    78</table>
    79{{/typeParameters.0}}
    80
    81{{#fieldValue}}
    82<h5 class="fieldValue">{{__global.fieldValue}}</h5>
    83<table>
    84  <tr>
    85    <td>
    86      {{{type.specName.0.value}}}
    87      <p>{{{description}}}</p>
    88    </td>
    89  </tr>
    90</table>
    91{{/fieldValue}}
    92
    93{{#propertyValue}}
    94<h5 class="propertyValue">{{__global.propertyValue}}</h5>
    95<table>
    96  <tr>
    97    <td>
    98      {{{type.specName.0.value}}}
    99      <p>{{{description}}}</p>
   100    </td>
   101  </tr>
   102</table>
   103{{/propertyValue}}
   104
   105{{#eventType}}
   106<h5 class="eventType">{{__global.eventType}}</h5>
   107<table>
   108  <tr>
   109    <td>
   110      {{{type.specName.0.value}}}
   111      <p>{{{description}}}</p>
   112    </td>
   113  </tr>
   114</table>
   115{{/eventType}}
   116{{/syntax}}
   117
   118{{#overridden}}
   119<h5 class="overrides">{{__global.overrides}}</h5>
   120<div><xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/></div>
   121{{/overridden}}
   122
   123{{#implements.0}}
   124<h5 class="implements">{{__global.implements}}</h5>
   125{{/implements.0}}
   126{{#implements}}
   127  {{#definition}}
   128    <div><xref uid="{{definition}}" altProperty="fullName" displayProperty="nameWithType"/></div>
   129  {{/definition}}
   130  {{^definition}}
   131    <div><xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/></div>
   132  {{/definition}}
   133{{/implements}}
   134
   135{{#remarks}}
   136<h5 id="{{id}}_remarks">{{__global.remarks}}</h5>
   137<div class="markdown level1 remarks">{{{remarks}}}</div>
   138{{/remarks}}
   139
   140{{#example.0}}
   141<h5 id="{{id}}_examples">{{__global.examples}}</h5>
   142{{/example.0}}
   143{{#example}}
   144{{{.}}}
   145{{/example}}
   146
   147{{#exceptions.0}}
   148<h5 class="exceptions">{{__global.exceptions}}</h5>
   149<table>
   150{{/exceptions.0}}
   151{{#exceptions}}
   152  <tr>
   153    <td>
   154      {{{type.specName.0.value}}}
   155      <p>{{{description}}}</p>
   156    </td>
   157  </tr>
   158{{/exceptions}}
   159{{#exceptions.0}}
   160</table>
   161{{/exceptions.0}}
   162
   163{{#seealso.0}}
   164<h5 id="{{id}}_seealso">{{__global.seealso}}</h5>
   165<div class="seealso">
   166{{/seealso.0}}
   167{{#seealso}}
   168  {{#isCref}}
   169    <div>{{{type.specName.0.value}}}</div>
   170  {{/isCref}}
   171  {{^isCref}}
   172    <div>{{{url}}}</div>
   173  {{/isCref}}
   174{{/seealso}}
   175{{#seealso.0}}
   176</div>
   177{{/seealso.0}}
   178</div>
   179{{/children}}
   180{{/children}}
   181
   182{{#extensionMethods.0}}
   183<h3 id="extensionmethods">{{__global.extensionMethods}}</h3>
   184{{/extensionMethods.0}}
   185{{#extensionMethods}}
   186<div>
   187  {{#definition}}
   188    <xref uid="{{definition}}" altProperty="fullName" displayProperty="nameWithType"/>
   189  {{/definition}}
   190  {{^definition}}
   191    <xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/>
   192  {{/definition}}
   193</div>
   194{{/extensionMethods}}
   195
   196{{#seealso.0}}
   197<h3 id="seealso">{{__global.seealso}}</h3>
   198<div class="seealso">
   199{{/seealso.0}}
   200{{#seealso}}
   201  {{#isCref}}
   202    <div>{{{type.specName.0.value}}}</div>
   203  {{/isCref}}
   204  {{^isCref}}
   205    <div>{{{url}}}</div>
   206  {{/isCref}}
   207{{/seealso}}
   208{{#seealso.0}}
   209</div>
   210{{/seealso.0}}

View as plain text