Add docs template

This commit is contained in:
Karl Burtram
2016-12-15 17:06:28 -08:00
275 changed files with 10751 additions and 19075 deletions

View File

@@ -10,43 +10,45 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class SqlCompletionItem
">
<meta name="generator" content="docfx 1.0.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="http://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/style.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix">
<!--
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-63735192-1', 'auto');
ga('send', 'pageview');
</script>
-->
</head> <body data-spy="scroll" data-target="#affix">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<nav class="navbar navbar-inverse">
<div class="container">
<a href="../"><img height="50px" src="../images/sqlserver.png" style="float:right;"></a>
<div class="navbar-header ">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../"><span class="dotnet">SQL Tools Service</span></a>
</div>
<div id="navbar" class="collapse navbar-collapse">
</div><!--/.nav-collapse -->
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
@@ -68,7 +70,8 @@
<div class="col-md-10">
<article class="content wrap" id="_content">
<a href="https://github.com/Microsoft/sqltoolsservice/new/master/docs/apispec/new?filename=Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="pull-right mobile-hide"><span class="fa fa-github"></span>Improve this Doc</a>
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L18" class="pull-right mobile-hide">View Source</a>
<h1 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem">Class SqlCompletionItem
</h1>
<div class="markdown level0 summary"><p>Creates a completion item from SQL parser declaration item</p>
@@ -79,30 +82,6 @@
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">SqlCompletionItem</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>:Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion</h6>
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
<h5 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_syntax">Syntax</h5>
@@ -118,7 +97,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L25">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.#ctor*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem__ctor_Microsoft_SqlServer_Management_SqlParser_Intellisense_Declaration_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.#ctor(Microsoft.SqlServer.Management.SqlParser.Intellisense.Declaration,System.String)">SqlCompletionItem(Declaration, String)</h4>
<div class="markdown level1 summary"><p>Create new instance given the SQL parser declaration</p>
</div>
@@ -139,12 +117,12 @@
<tbody>
<tr>
<td><span class="xref">Microsoft.SqlServer.Management.SqlParser.Intellisense.Declaration</span></td>
<td><span class="parametername">declaration</span></td>
<td><em>declaration</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">tokenText</span></td>
<td><em>tokenText</em></td>
<td></td>
</tr>
</tbody>
@@ -156,7 +134,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L33">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem__ctor_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.#ctor*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem__ctor_System_String_Microsoft_SqlServer_Management_SqlParser_Intellisense_DeclarationType_System_String_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.#ctor(System.String,Microsoft.SqlServer.Management.SqlParser.Intellisense.DeclarationType,System.String)">SqlCompletionItem(String, DeclarationType, String)</h4>
<div class="markdown level1 summary"><p>Creates new instance given declaration title and type</p>
</div>
@@ -177,17 +154,17 @@
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">declarationTitle</span></td>
<td><em>declarationTitle</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Microsoft.SqlServer.Management.SqlParser.Intellisense.DeclarationType</span></td>
<td><span class="parametername">declarationType</span></td>
<td><em>declarationType</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">tokenText</span></td>
<td><em>tokenText</em></td>
<td></td>
</tr>
</tbody>
@@ -201,7 +178,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L91">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_DeclarationTitle_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.DeclarationTitle*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_DeclarationTitle" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.DeclarationTitle">DeclarationTitle</h4>
<div class="markdown level1 summary"><p>Declaration Title</p>
</div>
@@ -210,7 +186,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string DeclarationTitle { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -232,7 +208,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L101">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_DeclarationType_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.DeclarationType*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_DeclarationType" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.DeclarationType">DeclarationType</h4>
<div class="markdown level1 summary"><p>SQL declaration type</p>
</div>
@@ -241,7 +216,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DeclarationType DeclarationType { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -263,7 +238,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L121">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_Detail_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.Detail*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_Detail" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.Detail">Detail</h4>
<div class="markdown level1 summary"><p>Completion item detail</p>
</div>
@@ -272,7 +246,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Detail { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -294,7 +268,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L116">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_InsertText_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.InsertText*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_InsertText" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.InsertText">InsertText</h4>
<div class="markdown level1 summary"><p>Completion insert text</p>
</div>
@@ -303,7 +276,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string InsertText { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -325,7 +298,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L111">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_Kind_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.Kind*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_Kind" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.Kind">Kind</h4>
<div class="markdown level1 summary"><p>Completion item kind</p>
</div>
@@ -334,7 +306,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CompletionItemKind Kind { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -356,7 +328,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L106">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_Label_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.Label*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_Label" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.Label">Label</h4>
<div class="markdown level1 summary"><p>Completion item label</p>
</div>
@@ -365,7 +336,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Label { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -387,7 +358,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L96">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_TokenText_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.TokenText*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_TokenText" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.TokenText">TokenText</h4>
<div class="markdown level1 summary"><p>Token text from the editor</p>
</div>
@@ -396,7 +366,7 @@
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string TokenText { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -420,7 +390,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L126">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_CreateCompletionItem_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.CreateCompletionItem*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_CreateCompletionItem_System_Int32_System_Int32_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.CreateCompletionItem(System.Int32,System.Int32,System.Int32)">CreateCompletionItem(Int32, Int32, Int32)</h4>
<div class="markdown level1 summary"><p>Creates a completion item given the editor info</p>
</div>
@@ -441,17 +410,17 @@
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">row</span></td>
<td><em>row</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">startColumn</span></td>
<td><em>startColumn</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">endColumn</span></td>
<td><em>endColumn</em></td>
<td></td>
</tr>
</tbody>
@@ -478,7 +447,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Completion/SqlCompletionItem.cs/#L137">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_CreateCompletionItem_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.CreateCompletionItem*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Completion_SqlCompletionItem_CreateCompletionItem_System_String_System_String_System_String_Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItemKind_System_Int32_System_Int32_System_Int32_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Completion.SqlCompletionItem.CreateCompletionItem(System.String,System.String,System.String,Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItemKind,System.Int32,System.Int32,System.Int32)">CreateCompletionItem(String, String, String, CompletionItemKind, Int32, Int32, Int32)</h4>
<div class="markdown level1 summary"><p>Creates a completion item</p>
</div>
@@ -499,37 +467,37 @@
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">label</span></td>
<td><em>label</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">detail</span></td>
<td><em>detail</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">insertText</span></td>
<td><em>insertText</em></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItemKind.html">CompletionItemKind</a></td>
<td><span class="parametername">kind</span></td>
<td><em>kind</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">row</span></td>
<td><em>row</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">startColumn</span></td>
<td><em>startColumn</em></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">endColumn</span></td>
<td><em>endColumn</em></td>
<td></td>
</tr>
</tbody>
@@ -573,16 +541,9 @@
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Copyright © 2015-2016 Microsoft<br>Generated by <strong>DocFX</strong></span>
<div class="inner-footer">
<p>© Microsoft &nbsp;//&nbsp; Generated with <a href="https://github.com/dotnet/docfx">DocFX</a></p>
</div>
</div>
</footer>
</div>