class.header.tmpl.partial 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. {{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
  2. <h1 id="{{id}}" data-uid="{{uid}}" class="text-break">{{>partials/title}}</h1>
  3. <div class="markdown level0 summary">{{{summary}}}</div>
  4. <div class="markdown level0 conceptual">{{{conceptual}}}</div>
  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. {{#derivedClasses}}
  13. <div class="level{{index}}">{{{specName.0.value}}}</div>
  14. {{/derivedClasses}}
  15. </div>
  16. {{/inClass}}
  17. {{#implements.0}}
  18. <div class="implements">
  19. <h5>{{__global.implements}}</h5>
  20. {{/implements.0}}
  21. {{#implements}}
  22. <div>{{{specName.0.value}}}</div>
  23. {{/implements}}
  24. {{#implements.0}}
  25. </div>
  26. {{/implements.0}}
  27. {{#remarks}}
  28. <h5 id="{{id}}_remarks"><strong>{{__global.remarks}}</strong></h5>
  29. <div class="markdown level0 remarks">{{{remarks}}}</div>
  30. {{/remarks}}
  31. {{#example.0}}
  32. <h5 id="{{id}}_examples"><strong>{{__global.examples}}</strong></h5>
  33. {{/example.0}}
  34. {{#example}}
  35. {{{.}}}
  36. {{/example}}
  37. {{#inheritedMembers.0}}
  38. <div class="inheritedMembers">
  39. <h5>{{__global.inheritedMembers}}</h5>
  40. {{/inheritedMembers.0}}
  41. {{#inheritedMembers}}
  42. <div>
  43. {{#definition}}
  44. <xref uid="{{definition}}" text="{{nameWithType.0.value}}" alt="{{fullName.0.value}}"/>
  45. {{/definition}}
  46. {{^definition}}
  47. <xref uid="{{uid}}" text="{{nameWithType.0.value}}" alt="{{fullName.0.value}}"/>
  48. {{/definition}}
  49. </div>
  50. {{/inheritedMembers}}
  51. {{#inheritedMembers.0}}
  52. </div>
  53. {{/inheritedMembers.0}}
  54. <h6><strong>{{__global.namespace}}</strong>: {{{namespace.specName.0.value}}}</h6>
  55. <h6><strong>{{__global.assembly}}</strong>: {{assemblies.0}}.dll</h6>
  56. <h5 id="{{id}}_syntax">{{__global.syntax}}</h5>
  57. <div class="codewrapper">
  58. <pre><code class="lang-{{_lang}} hljs">{{syntax.content.0.value}}</code></pre>
  59. </div>
  60. {{#syntax.parameters.0}}
  61. <h5 class="parameters">{{__global.parameters}}</h5>
  62. <table class="table table-bordered table-striped table-condensed">
  63. <thead>
  64. <tr>
  65. <th>{{__global.type}}</th>
  66. <th>{{__global.name}}</th>
  67. <th>{{__global.description}}</th>
  68. </tr>
  69. </thead>
  70. <tbody>
  71. {{/syntax.parameters.0}}
  72. {{#syntax.parameters}}
  73. <tr>
  74. <td>{{{type.specName.0.value}}}</td>
  75. <td><span class="parametername">{{{id}}}</span></td>
  76. <td>{{{description}}}</td>
  77. </tr>
  78. {{/syntax.parameters}}
  79. {{#syntax.parameters.0}}
  80. </tbody>
  81. </table>
  82. {{/syntax.parameters.0}}
  83. {{#syntax.return}}
  84. <h5 class="returns">{{__global.returns}}</h5>
  85. <table class="table table-bordered table-striped table-condensed">
  86. <thead>
  87. <tr>
  88. <th>{{__global.type}}</th>
  89. <th>{{__global.description}}</th>
  90. </tr>
  91. </thead>
  92. <tbody>
  93. <tr>
  94. <td>{{{type.specName.0.value}}}</td>
  95. <td>{{{description}}}</td>
  96. </tr>
  97. </tbody>
  98. </table>
  99. {{/syntax.return}}
  100. {{#syntax.typeParameters.0}}
  101. <h5 class="typeParameters">{{__global.typeParameters}}</h5>
  102. <table class="table table-bordered table-striped table-condensed">
  103. <thead>
  104. <tr>
  105. <th>{{__global.name}}</th>
  106. <th>{{__global.description}}</th>
  107. </tr>
  108. </thead>
  109. <tbody>
  110. {{/syntax.typeParameters.0}}
  111. {{#syntax.typeParameters}}
  112. <tr>
  113. <td><span class="parametername">{{{id}}}</span></td>
  114. <td>{{{description}}}</td>
  115. </tr>
  116. {{/syntax.typeParameters}}
  117. {{#syntax.typeParameters.0}}
  118. </tbody>
  119. </table>
  120. {{/syntax.typeParameters.0}}