class.header.tmpl.partial 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
  1. {{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
  2. <h1 id="{{id}}" data-uid="{{uid}}" class="text-break">
  3. {{>partials/title}}
  4. {{#sourceurl}}<a class="header-action link-secondary" title="View source" href="{{sourceurl}}"><i class="bi bi-code-slash"></i></a>{{/sourceurl}}
  5. </h1>
  6. <div class="facts text-secondary">
  7. <dl><dt>{{__global.namespace}}</dt><dd>{{{namespace.specName.0.value}}}</dd></dl>
  8. {{#assemblies.0}}<dl><dt>{{__global.assembly}}</dt><dd>{{assemblies.0}}.dll</dd></dl>{{/assemblies.0}}
  9. </div>
  10. <div class="markdown summary">{{{summary}}}</div>
  11. <div class="markdown conceptual">{{{conceptual}}}</div>
  12. {{#syntax.content.0.value}}
  13. <div class="codewrapper">
  14. <pre><code class="lang-csharp hljs">{{syntax.content.0.value}}</code></pre>
  15. </div>
  16. {{/syntax.content.0.value}}
  17. {{#syntax.parameters.0}}
  18. <h4 class="section">{{__global.parameters}}</h4>
  19. <dl class="parameters">
  20. {{/syntax.parameters.0}}
  21. {{#syntax.parameters}}
  22. <dt><code>{{{id}}}</code> {{{type.specName.0.value}}}</dt>
  23. <dd>{{{description}}}</dd>
  24. {{/syntax.parameters}}
  25. {{#syntax.parameters.0}}
  26. </dl>
  27. {{/syntax.parameters.0}}
  28. {{#syntax.return}}
  29. <h4 class="section">{{__global.returns}}</h4>
  30. <dl class="parameters">
  31. <dt>{{{type.specName.0.value}}}</dt>
  32. <dd>{{{description}}}</dd>
  33. </dl>
  34. {{/syntax.return}}
  35. {{#syntax.typeParameters.0}}
  36. <h4 class="section">{{__global.typeParameters}}</h4>
  37. <dl class="parameters">
  38. {{/syntax.typeParameters.0}}
  39. {{#syntax.typeParameters}}
  40. <dt><code>{{{id}}}</code></dt>
  41. <dd>{{{description}}}</dd>
  42. {{/syntax.typeParameters}}
  43. {{#syntax.typeParameters.0}}
  44. </dl>
  45. {{/syntax.typeParameters.0}}
  46. {{#inClass}}
  47. {{#inheritance.0}}
  48. <dl class="typelist inheritance">
  49. <dt>{{__global.inheritance}}</dt>
  50. <dd>
  51. {{/inheritance.0}}
  52. {{#inheritance}}
  53. <div>{{{specName.0.value}}}</div>
  54. {{/inheritance}}
  55. <div><span class="xref">{{name.0.value}}</span></div>
  56. {{#inheritance.0}}
  57. </dd>
  58. </dl>
  59. {{/inheritance.0}}
  60. {{/inClass}}
  61. {{#implements.0}}
  62. <dl class="typelist implements">
  63. <dt>{{__global.implements}}</dt>
  64. <dd>
  65. {{/implements.0}}
  66. {{#implements}}
  67. <div>{{{specName.0.value}}}</div>
  68. {{/implements}}
  69. {{#implements.0}}
  70. </dd>
  71. </dl>
  72. {{/implements.0}}
  73. {{#inClass}}
  74. {{#derivedClasses.0}}
  75. <dl class="typelist derived">
  76. <dt>{{__global.derived}}</dt>
  77. <dd>
  78. {{/derivedClasses.0}}
  79. {{#derivedClasses}}
  80. <div>{{{specName.0.value}}}</div>
  81. {{/derivedClasses}}
  82. {{#derivedClasses.0}}
  83. </dd>
  84. </dl>
  85. {{/derivedClasses.0}}
  86. {{/inClass}}
  87. {{#inheritedMembers.0}}
  88. <dl class="typelist derived">
  89. <dt>{{__global.inheritedMembers}}</dt>
  90. <dd>
  91. {{/inheritedMembers.0}}
  92. {{#inheritedMembers}}
  93. <div>
  94. {{#definition}}
  95. <xref uid="{{definition}}" text="{{nameWithType.0.value}}" alt="{{fullName.0.value}}"/>
  96. {{/definition}}
  97. {{^definition}}
  98. <xref uid="{{uid}}" text="{{nameWithType.0.value}}" alt="{{fullName.0.value}}"/>
  99. {{/definition}}
  100. </div>
  101. {{/inheritedMembers}}
  102. {{#inheritedMembers.0}}
  103. </dl>
  104. {{/inheritedMembers.0}}
  105. {{#extensionMethods.0}}
  106. <dl class="typelist extensionMethods">
  107. <dt>{{__global.extensionMethods}}</dt>
  108. <dd>
  109. {{/extensionMethods.0}}
  110. {{#extensionMethods}}
  111. <div>
  112. {{#definition}}
  113. <xref uid="{{definition}}" altProperty="fullName" displayProperty="nameWithType"/>
  114. {{/definition}}
  115. {{^definition}}
  116. <xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/>
  117. {{/definition}}
  118. </div>
  119. {{/extensionMethods}}
  120. {{#extensionMethods.0}}
  121. </dl>
  122. {{/extensionMethods.0}}
  123. {{#isEnum}}
  124. {{#children}}
  125. <h2 id="{{id}}">{{>partials/classSubtitle}}</h2>
  126. <dl class="parameters">
  127. {{#children}}
  128. <dt id="{{id}}"><code>{{syntax.content.0.value}}</code></dt>
  129. <dd>{{{summary}}}</dd>
  130. {{/children}}
  131. </dl>
  132. {{/children}}
  133. {{/isEnum}}
  134. {{#example.0}}
  135. <h2 id="{{id}}_examples">{{__global.examples}}</h2>
  136. {{/example.0}}
  137. {{#example}}
  138. {{{.}}}
  139. {{/example}}
  140. {{#remarks}}
  141. <h2 id="{{id}}_remarks">{{__global.remarks}}</h2>
  142. <div class="markdown level0 remarks">{{{remarks}}}</div>
  143. {{/remarks}}