+ {{^_disableToc}} + {{>partials/toc}} +
+ {{/_disableToc}} + {{#_disableToc}} +
+ {{/_disableToc}} + {{#_disableAffix}} +
+ {{/_disableAffix}} + {{^_disableAffix}} +
+ {{/_disableAffix}} +
+ {{!body}} +
+
+ {{^_disableAffix}} + {{>partials/affix}} + {{/_disableAffix}} +
+
+ {{^_disableFooter}} + {{>partials/footer}} + {{/_disableFooter}} +
+ {{>partials/scripts}} + + diff --git a/basefiles/docfx template/custom/logo.svg b/basefiles/docfx template/custom/logo.svg new file mode 100644 index 0000000..022ba7a --- /dev/null +++ b/basefiles/docfx template/custom/logo.svg @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/basefiles/docfx template/custom/partials/_affix.liquid b/basefiles/docfx template/custom/partials/_affix.liquid new file mode 100644 index 0000000..d06b036 --- /dev/null +++ b/basefiles/docfx template/custom/partials/_affix.liquid @@ -0,0 +1,25 @@ +{% comment -%}Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.{% endcomment -%} + diff --git a/basefiles/docfx template/custom/partials/_breadcrumb.liquid b/basefiles/docfx template/custom/partials/_breadcrumb.liquid new file mode 100644 index 0000000..3bf0d72 --- /dev/null +++ b/basefiles/docfx template/custom/partials/_breadcrumb.liquid @@ -0,0 +1,8 @@ +{% comment -%}Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.{% endcomment -%} +
+ +
diff --git a/basefiles/docfx template/custom/partials/_footer.liquid b/basefiles/docfx template/custom/partials/_footer.liquid new file mode 100644 index 0000000..ddc2672 --- /dev/null +++ b/basefiles/docfx template/custom/partials/_footer.liquid @@ -0,0 +1,16 @@ +{% comment -%}Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.{% endcomment -%} +
+
+
+
+ + Back to top + + {%- if _appFooter -%} + {{_appFooter}} + {%- else -%} + Copyright © Microsoft.
Generated by DocFX + {%- endif -%} +
+
+
diff --git a/basefiles/docfx template/custom/partials/_head.liquid b/basefiles/docfx template/custom/partials/_head.liquid new file mode 100644 index 0000000..2af71a6 --- /dev/null +++ b/basefiles/docfx template/custom/partials/_head.liquid @@ -0,0 +1,38 @@ +{% comment -%}Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.{% endcomment -%} + + + + {%- if title and _appTitle -%} + {{title}} | {{appTitle}} + + {%- else -%} + {%- if title or _appTitle -%} + {{title}}{{appTitle}} + + {%- endif -%} + {%- endif -%} + + + {%- if _description -%} + + {%- endif -%} + {%- if _appFaviconPath -%} + + {%- else -%} + + {%- endif -%} + + + + + + {%- if _noindex -%} + + {%- endif -%} + {%- if _enableSearch -%} + + {%- endif -%} + {%- if _enableNewTab -%} + + {%- endif -%} + diff --git a/basefiles/docfx template/custom/partials/_logo.liquid b/basefiles/docfx template/custom/partials/_logo.liquid new file mode 100644 index 0000000..7bc65a6 --- /dev/null +++ b/basefiles/docfx template/custom/partials/_logo.liquid @@ -0,0 +1,8 @@ +{% comment -%}Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.{% endcomment -%} + + {%- if _appLogoPath -%} + + {%- else -%} + + {%- endif -%} + diff --git a/basefiles/docfx template/custom/partials/_navbar.liquid b/basefiles/docfx template/custom/partials/_navbar.liquid new file mode 100644 index 0000000..bcfde28 --- /dev/null +++ b/basefiles/docfx template/custom/partials/_navbar.liquid @@ -0,0 +1,21 @@ +{% comment -%}Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.{% endcomment -%} + diff --git a/basefiles/docfx template/custom/partials/_scripts.liquid b/basefiles/docfx template/custom/partials/_scripts.liquid new file mode 100644 index 0000000..6640a85 --- /dev/null +++ b/basefiles/docfx template/custom/partials/_scripts.liquid @@ -0,0 +1,4 @@ +{% comment -%}Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.{% endcomment -%} + + + diff --git a/basefiles/docfx template/custom/partials/_toc.liquid b/basefiles/docfx template/custom/partials/_toc.liquid new file mode 100644 index 0000000..ea6706e --- /dev/null +++ b/basefiles/docfx template/custom/partials/_toc.liquid @@ -0,0 +1,7 @@ +{% comment -%}Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.{% endcomment -%} +
+ +
+
+
+
diff --git a/basefiles/docfx template/custom/partials/affix.tmpl.partial b/basefiles/docfx template/custom/partials/affix.tmpl.partial new file mode 100644 index 0000000..c2882e3 --- /dev/null +++ b/basefiles/docfx template/custom/partials/affix.tmpl.partial @@ -0,0 +1,26 @@ +{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} + + diff --git a/basefiles/docfx template/custom/partials/breadcrumb.tmpl.partial b/basefiles/docfx template/custom/partials/breadcrumb.tmpl.partial new file mode 100644 index 0000000..f63f7e3 --- /dev/null +++ b/basefiles/docfx template/custom/partials/breadcrumb.tmpl.partial @@ -0,0 +1,9 @@ +{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} + +
+ +
diff --git a/basefiles/docfx template/custom/partials/class.header.tmpl.partial b/basefiles/docfx template/custom/partials/class.header.tmpl.partial new file mode 100644 index 0000000..1a732fb --- /dev/null +++ b/basefiles/docfx template/custom/partials/class.header.tmpl.partial @@ -0,0 +1,121 @@ +{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} + +

{{>partials/title}}

+
{{{summary}}}
+
{{{conceptual}}}
+{{#inClass}} +
+
{{__global.inheritance}}
+ {{#inheritance}} +
{{{specName.0.value}}}
+ {{/inheritance}} +
{{name.0.value}}
+ {{#derivedClasses}} +
{{{specName.0.value}}}
+ {{/derivedClasses}} +
+{{/inClass}} +{{#implements.0}} +
+
{{__global.implements}}
+{{/implements.0}} +{{#implements}} +
{{{specName.0.value}}}
+{{/implements}} +{{#implements.0}} +
+{{/implements.0}} +{{#inheritedMembers.0}} +
+
{{__global.inheritedMembers}}
+{{/inheritedMembers.0}} +{{#inheritedMembers}} +
+ {{#definition}} + + {{/definition}} + {{^definition}} + + {{/definition}} +
+{{/inheritedMembers}} +{{#inheritedMembers.0}} +
+{{/inheritedMembers.0}} +
{{__global.namespace}}: {{{namespace.specName.0.value}}}
+
{{__global.assembly}}: {{assemblies.0}}.dll
+
{{__global.syntax}}
+
+ 
{{syntax.content.0.value}}
+
+{{#syntax.parameters.0}} +
{{__global.parameters}}
+ + + + + + + + + +{{/syntax.parameters.0}} +{{#syntax.parameters}} + + + + + +{{/syntax.parameters}} +{{#syntax.parameters.0}} + +
{{__global.type}}{{__global.name}}{{__global.description}}
{{{type.specName.0.value}}}{{{id}}}{{{description}}}
+{{/syntax.parameters.0}} +{{#syntax.return}} +
{{__global.returns}}
+ + + + + + + + + + + + + +
{{__global.type}}{{__global.description}}
{{{type.specName.0.value}}}{{{description}}}
+{{/syntax.return}} +{{#syntax.typeParameters.0}} +
{{__global.typeParameters}}
+ + + + + + + + +{{/syntax.typeParameters.0}} +{{#syntax.typeParameters}} + + + + +{{/syntax.typeParameters}} +{{#syntax.typeParameters.0}} + +
{{__global.name}}{{__global.description}}
{{{id}}}{{{description}}}
+{{/syntax.typeParameters.0}} +{{#remarks}} +
{{__global.remarks}}
+
{{{remarks}}}
+{{/remarks}} +{{#example.0}} +
{{__global.examples}}
+{{/example.0}} +{{#example}} +{{{.}}} +{{/example}} diff --git a/basefiles/docfx template/custom/partials/class.tmpl.partial b/basefiles/docfx template/custom/partials/class.tmpl.partial new file mode 100644 index 0000000..7490fbe --- /dev/null +++ b/basefiles/docfx template/custom/partials/class.tmpl.partial @@ -0,0 +1,234 @@ +{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} + +{{>partials/class.header}} +{{#children}} +

{{>partials/classSubtitle}}

+{{#children}} +{{^_disableContribution}} +{{#docurl}} + + | + {{__global.improveThisDoc}} +{{/docurl}} +{{#sourceurl}} + + {{__global.viewSource}} +{{/sourceurl}} +{{/_disableContribution}} +{{#overload}} + +{{/overload}} +

{{name.0.value}}

+
{{{summary}}}
+
{{{conceptual}}}
+
{{__global.declaration}}
+{{#syntax}} +
+ 
{{syntax.content.0.value}}
+
+{{#parameters.0}} +
{{__global.parameters}}
+ + + + + + + + + +{{/parameters.0}} +{{#parameters}} + + + + + +{{/parameters}} +{{#parameters.0}} + +
{{__global.type}}{{__global.name}}{{__global.description}}
{{{type.specName.0.value}}}{{{id}}}{{{description}}}
+{{/parameters.0}} +{{#return}} +
{{__global.returns}}
+ + + + + + + + + + + + + +
{{__global.type}}{{__global.description}}
{{{type.specName.0.value}}}{{{description}}}
+{{/return}} +{{#typeParameters.0}} +
{{__global.typeParameters}}
+ + + + + + + + +{{/typeParameters.0}} +{{#typeParameters}} + + + + +{{/typeParameters}} +{{#typeParameters.0}} + +
{{__global.name}}{{__global.description}}
{{{id}}}{{{description}}}
+{{/typeParameters.0}} +{{#fieldValue}} +
{{__global.fieldValue}}
+ + + + + + + + + + + + + +
{{__global.type}}{{__global.description}}
{{{type.specName.0.value}}}{{{description}}}
+{{/fieldValue}} +{{#propertyValue}} +
{{__global.propertyValue}}
+ + + + + + + + + + + + + +
{{__global.type}}{{__global.description}}
{{{type.specName.0.value}}}{{{description}}}
+{{/propertyValue}} +{{#eventType}} +
{{__global.eventType}}
+ + + + + + + + + + + + + +
{{__global.type}}{{__global.description}}
{{{type.specName.0.value}}}{{{description}}}
+{{/eventType}} +{{/syntax}} +{{#overridden}} +
{{__global.overrides}}
+
+{{/overridden}} +{{#remarks}} +
{{__global.remarks}}
+
{{{remarks}}}
+{{/remarks}} +{{#example.0}} +
{{__global.examples}}
+{{/example.0}} +{{#example}} +{{{.}}} +{{/example}} +{{#exceptions.0}} +
{{__global.exceptions}}
+ + + + + + + + +{{/exceptions.0}} +{{#exceptions}} + + + + +{{/exceptions}} +{{#exceptions.0}} + +
{{__global.type}}{{__global.condition}}
{{{type.specName.0.value}}}{{{description}}}
+{{/exceptions.0}} +{{#seealso.0}} +
{{__global.seealso}}
+
+{{/seealso.0}} +{{#seealso}} + {{#isCref}} +
{{{type.specName.0.value}}}
+ {{/isCref}} + {{^isCref}} +
{{{url}}}
+ {{/isCref}} +{{/seealso}} +{{#seealso.0}} +
+{{/seealso.0}} +{{/children}} +{{/children}} +{{#implements.0}} +

{{__global.implements}}

+{{/implements.0}} +{{#implements}} +
+ {{#definition}} + + {{/definition}} + {{^definition}} + + {{/definition}} +
+{{/implements}} +{{#extensionMethods.0}} +

{{__global.extensionMethods}}

+{{/extensionMethods.0}} +{{#extensionMethods}} +
+ {{#definition}} + + {{/definition}} + {{^definition}} + + {{/definition}} +
+{{/extensionMethods}} +{{#seealso.0}} +

{{__global.seealso}}

+
+{{/seealso.0}} +{{#seealso}} + {{#isCref}} +
{{{type.specName.0.value}}}
+ {{/isCref}} + {{^isCref}} +
{{{url}}}
+ {{/isCref}} +{{/seealso}} +{{#seealso.0}} +
+{{/seealso.0}} diff --git a/basefiles/docfx template/custom/partials/classSubtitle.tmpl.partial b/basefiles/docfx template/custom/partials/classSubtitle.tmpl.partial new file mode 100644 index 0000000..5caea36 --- /dev/null +++ b/basefiles/docfx template/custom/partials/classSubtitle.tmpl.partial @@ -0,0 +1,28 @@ +{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{#inConstructor}} +{{__global.constructorsInSubtitle}} +{{/inConstructor}} +{{#inField}} +{{__global.fieldsInSubtitle}} +{{/inField}} +{{#inProperty}} +{{__global.propertiesInSubtitle}} +{{/inProperty}} +{{#inMethod}} +{{__global.methodsInSubtitle}} +{{/inMethod}} +{{#inEvent}} +{{__global.eventsInSubtitle}} +{{/inEvent}} +{{#inOperator}} +{{__global.operatorsInSubtitle}} +{{/inOperator}} +{{#inEii}} +{{__global.eiisInSubtitle}} +{{/inEii}} +{{#inFunction}} +{{__global.functionsInSubtitle}} +{{/inFunction}} +{{#inMember}} +{{__global.membersInSubtitle}} +{{/inMember}} \ No newline at end of file diff --git a/basefiles/docfx template/custom/partials/customMREFContent.tmpl.partial b/basefiles/docfx template/custom/partials/customMREFContent.tmpl.partial new file mode 100644 index 0000000..67395b8 --- /dev/null +++ b/basefiles/docfx template/custom/partials/customMREFContent.tmpl.partial @@ -0,0 +1,2 @@ +{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Add your own custom template for the content for ManagedReference here}} \ No newline at end of file diff --git a/basefiles/docfx template/custom/partials/dd-li.tmpl.partial b/basefiles/docfx template/custom/partials/dd-li.tmpl.partial new file mode 100644 index 0000000..75636c2 --- /dev/null +++ b/basefiles/docfx template/custom/partials/dd-li.tmpl.partial @@ -0,0 +1,3 @@ +{{#items}} +
  • {{name}}
    • +{{/items}} diff --git a/basefiles/docfx template/custom/partials/enum.tmpl.partial b/basefiles/docfx template/custom/partials/enum.tmpl.partial new file mode 100644 index 0000000..b5584ad --- /dev/null +++ b/basefiles/docfx template/custom/partials/enum.tmpl.partial @@ -0,0 +1,50 @@ +{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} + +{{>partials/class.header}} +{{#children}} +

    {{>partials/classSubtitle}}

    + + + + + + + + + {{#children}} + + + + + {{/children}} + +
    {{__global.name}}{{__global.description}}
    {{name.0.value}}{{{summary}}}
    +{{/children}} +{{#seealso.0}} +
    {{__global.seealso}}
    +
    +{{/seealso.0}} +{{#seealso}} + {{#isCref}} +
    {{{type.specName.0.value}}}
    + {{/isCref}} + {{^isCref}} +
    {{{url}}}
    + {{/isCref}} +{{/seealso}} +{{#seealso.0}} +
    +{{/seealso.0}} +{{#extensionMethods.0}} +

    {{__global.extensionMethods}}

    +{{/extensionMethods.0}} +{{#extensionMethods}} +
    + {{#definition}} + + {{/definition}} + {{^definition}} + + {{/definition}} +
    +{{/extensionMethods}} diff --git a/basefiles/docfx template/custom/partials/footer.tmpl.partial b/basefiles/docfx template/custom/partials/footer.tmpl.partial new file mode 100644 index 0000000..5bd4cb6 --- /dev/null +++ b/basefiles/docfx template/custom/partials/footer.tmpl.partial @@ -0,0 +1,19 @@ +{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} + +