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 CompletionItem
">
<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_Contracts_CompletionItem.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem%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/Contracts/Completion.cs/#L56" class="pull-right mobile-hide">View Source</a>
<h1 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem">Class CompletionItem
</h1>
<div class="markdown level0 summary"></div>
@@ -78,30 +81,6 @@
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">CompletionItem</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.Contracts</h6>
<h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
<h5 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_syntax">Syntax</h5>
@@ -117,7 +96,6 @@
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L84">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Data_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Data*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Data" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Data">Data</h4>
<div class="markdown level1 summary"><p>Gets or sets a custom data field that allows the server to mark
each completion item with an identifier that will help correlate
@@ -129,7 +107,7 @@ resolve request.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object Data { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -151,7 +129,6 @@ resolve request.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L63">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Detail_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Detail*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Detail" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Detail">Detail</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
@@ -159,7 +136,7 @@ resolve request.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Detail { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -181,7 +158,6 @@ resolve request.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L68">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Documentation_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Documentation*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Documentation" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Documentation">Documentation</h4>
<div class="markdown level1 summary"><p>Gets or sets the documentation string for the completion item.</p>
</div>
@@ -190,7 +166,7 @@ resolve request.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Documentation { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -212,7 +188,6 @@ resolve request.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L72">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_FilterText_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.FilterText*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_FilterText" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.FilterText">FilterText</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
@@ -220,7 +195,7 @@ resolve request.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string FilterText { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -242,7 +217,6 @@ resolve request.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L74">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_InsertText_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.InsertText*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_InsertText" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.InsertText">InsertText</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
@@ -250,7 +224,7 @@ resolve request.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string InsertText { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -272,7 +246,6 @@ resolve request.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L61">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Kind_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Kind*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Kind" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Kind">Kind</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
@@ -280,7 +253,7 @@ resolve request.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CompletionItemKind? Kind { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -302,7 +275,6 @@ resolve request.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L59">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Label_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Label*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_Label" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.Label">Label</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
@@ -310,7 +282,7 @@ resolve request.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Label { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -332,7 +304,6 @@ resolve request.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L70">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_SortText_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.SortText*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_SortText" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.SortText">SortText</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
@@ -340,7 +311,7 @@ resolve request.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string SortText { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -362,7 +333,6 @@ resolve request.</p>
<span class="small pull-right mobile-hide">
<a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/LanguageServices/Contracts/Completion.cs/#L76">View Source</a>
</span>
<a id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_TextEdit_" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.TextEdit*"></a>
<h4 id="Microsoft_SqlTools_ServiceLayer_LanguageServices_Contracts_CompletionItem_TextEdit" data-uid="Microsoft.SqlTools.ServiceLayer.LanguageServices.Contracts.CompletionItem.TextEdit">TextEdit</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
@@ -370,7 +340,7 @@ resolve request.</p>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TextEdit TextEdit { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<h5 class="propertyValue"></h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
@@ -409,16 +379,9 @@ resolve request.</p>
</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>