mirror of
https://github.com/ckaczor/sqltoolsservice.git
synced 2026-01-14 01:25:40 -05:00
4964a52be5
This is documentation changes only so I'm just going to merge directly. The PR is for FYI purposes. Please leave feedback on the commit if you see anything I should follow-up on with this documentation.
136 lines
4.0 KiB
Plaintext
136 lines
4.0 KiB
Plaintext
{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
|
|
|
|
{{^_disableContribution}}
|
|
{{#docurl}}<a href="{{docurl}}" class="pull-right mobile-hide"><span class="fa fa-github"></span>{{__global.improveThisDoc}}</a>{{/docurl}}
|
|
{{#sourceurl}}<a href="{{sourceurl}}" class="pull-right mobile-hide">{{__global.viewSource}}</a>{{/sourceurl}}
|
|
{{/_disableContribution}}
|
|
<h1 id="{{id}}" data-uid="{{uid}}">{{>partials/title}}</h1>
|
|
<div class="markdown level0 summary">{{{summary}}}</div>
|
|
<div class="markdown level0 conceptual">{{{conceptual}}}</div>
|
|
{{#inheritance.0}}
|
|
<div class="inheritance">
|
|
<h5>{{__global.inheritance}}</h5>
|
|
{{#inheritance}}
|
|
<div class="level{{index}}">{{{specName.0.value}}}</div>
|
|
{{/inheritance}}
|
|
<div class="level{{item.level}}"><span class="xref">{{item.name.0.value}}</span></div>
|
|
</div>
|
|
{{/inheritance.0}}
|
|
<h6><strong>{{__global.namespace}}</strong>:{{namespace}}</h6>
|
|
<h6><strong>{{__global.assembly}}</strong>:{{assemblies.0}}.dll</h6>
|
|
<h5 id="{{id}}_syntax">{{__global.syntax}}</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-{{_lang}} hljs">{{syntax.content.0.value}}</code></pre>
|
|
</div>
|
|
{{#remarks}}
|
|
<h5 id="{{id}}_remarks"><strong>{{__global.remarks}}</strong></h5>
|
|
<div class="markdown level0 remarks">{{{remarks}}}</div>
|
|
{{/remarks}}
|
|
{{#children}}
|
|
<h3 id="{{id}}">{{>partials/classSubtitle}}</h3>
|
|
{{#children}}
|
|
{{^_disableContribution}}
|
|
{{#docurl}}
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="{{docurl}}">{{__global.improveThisDoc}}</a>
|
|
</span>{{/docurl}}
|
|
{{#sourceurl}}
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="{{sourceurl}}">{{__global.viewSource}}</a>
|
|
</span>{{/sourceurl}}
|
|
{{/_disableContribution}}
|
|
<h4 id="{{id}}" data-uid="{{uid}}">{{name.0.value}}</h4>
|
|
<div class="markdown level1 summary">{{{summary}}}</div>
|
|
<div class="markdown level1 conceptual">{{{conceptual}}}</div>
|
|
{{#remarks}}
|
|
<h5 id="{{id}}_remarks">{{__global.remarks}}</h5>
|
|
<div class="markdown level1 remarks">{{{remarks}}}</div>
|
|
{{/remarks}}
|
|
<h5 class="decalaration">{{__global.declaration}}</h5>
|
|
{{#syntax}}
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-{{_lang}} hljs">{{syntax.content.0.value}}</code></pre>
|
|
</div>
|
|
{{#parameters.0}}
|
|
<h5 class="parameters">{{__global.parameters}}</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>{{__global.type}}</th>
|
|
<th>{{__global.name}}</th>
|
|
<th>{{__global.description}}</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
{{/parameters.0}}
|
|
{{#parameters}}
|
|
<tr>
|
|
<td>{{{type.specName.0.value}}}</td>
|
|
<td><em>{{{id}}}</em></td>
|
|
<td>{{{description}}}</td>
|
|
</tr>
|
|
{{/parameters}}
|
|
{{#parameters.0}}
|
|
</tbody>
|
|
</table>
|
|
{{/parameters.0}}
|
|
{{#return}}
|
|
<h5 class="returns">{{__global.returns}}</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>{{__global.type}}</th>
|
|
<th>{{__global.description}}</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>{{{type.specName.0.value}}}</td>
|
|
<td>{{{description}}}</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
{{/return}}
|
|
{{#propertyValue}}
|
|
<h5 class="propertyValue">{{__global.provertyValue}}</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>{{__global.type}}</th>
|
|
<th>{{__global.description}}</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>{{{type.specName.0.value}}}</td>
|
|
<td>{{{description}}}</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
{{/propertyValue}}
|
|
{{/syntax}}
|
|
{{#exceptions.0}}
|
|
<h5 class="exceptions">{{__global.exceptions}}</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>{{__global.type}}</th>
|
|
<th>{{__global.condition}}</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
{{/exceptions.0}}
|
|
{{#exceptions}}
|
|
<tr>
|
|
<td>{{{type.specName.0.value}}}</td>
|
|
<td>{{{description}}}</td>
|
|
</tr>
|
|
{{/exceptions}}
|
|
{{#exceptions.0}}
|
|
</tbody>
|
|
</table>
|
|
{{/exceptions.0}}
|
|
{{/children}}
|
|
{{/children}}
|