Add docs template

2026-01-22 17:24:07 -05:00 · 2016-12-15 17:06:28 -08:00
parent b9f1c2b60e 2346ffff38
commit edb3c4aa1f
275 changed files with 10751 additions and 19075 deletions
--- a/docs/_site/api/Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.html
+++ b/docs/_site/api/Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.html
@@ -10,43 +10,45 @@
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class ServiceHost
   ">
-    <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_Hosting_ServiceHost.md&amp;value=---%0Auid%3A%20Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost%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/Hosting/ServiceHost.cs/#L23" class="pull-right mobile-hide">View Source</a>
              <h1 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost">Class ServiceHost
              </h1>
              <div class="markdown level0 summary"><p>SQL Tools VS Code Language Server request handler. Provides the entire JSON RPC
@@ -83,69 +86,6 @@ handlers that are registered prior to startup.</p>
                  <div class="level2"><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHostBase.html">ServiceHostBase</a></div>
                  <div class="level3"><span class="xref">ServiceHost</span></div>
              </div>
-              <div class="inheritedMembers">
-                <h5>Inherited Members</h5>
-                <div>
-                  <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHostBase.html#Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHostBase_OnStart">ServiceHostBase.OnStart()</a>
-                </div>
-                <div>
-                  <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_MessageDispatcher">ProtocolEndpoint.MessageDispatcher</a>
-                </div>
-                <div>
-                  <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_Start">ProtocolEndpoint.Start()</a>
-                </div>
-                <div>
-                  <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_WaitForExit">ProtocolEndpoint.WaitForExit()</a>
-                </div>
-                <div>
-                  <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_Stop">ProtocolEndpoint.Stop()</a>
-                </div>
-                <div>
-                  <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendRequest__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1____0_">ProtocolEndpoint.SendRequest&lt;TParams, TResult&gt;(RequestType&lt;TParams, TResult&gt;, TParams)</a>
-                </div>
-                <div>
-                  <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendRequest__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1____0_System_Boolean_">ProtocolEndpoint.SendRequest&lt;TParams, TResult&gt;(RequestType&lt;TParams, TResult&gt;, TParams, Boolean)</a>
-                </div>
-                <div>
-                  <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SendEvent__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0____0_">ProtocolEndpoint.SendEvent&lt;TParams&gt;(EventType&lt;TParams&gt;, TParams)</a>
-                </div>
-                <div>
-                  <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetRequestHandler__2_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_RequestType___0___1__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_RequestContext___1__System_Threading_Tasks_Task__">ProtocolEndpoint.SetRequestHandler&lt;TParams, TResult&gt;(RequestType&lt;TParams, TResult&gt;, Func&lt;TParams, RequestContext&lt;TResult&gt;, Task&gt;)</a>
-                </div>
-                <div>
-                  <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__">ProtocolEndpoint.SetEventHandler&lt;TParams&gt;(EventType&lt;TParams&gt;, Func&lt;TParams, EventContext, Task&gt;)</a>
-                </div>
-                <div>
-                  <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_SetEventHandler__1_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_Contracts_EventType___0__System_Func___0_Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_EventContext_System_Threading_Tasks_Task__System_Boolean_">ProtocolEndpoint.SetEventHandler&lt;TParams&gt;(EventType&lt;TParams&gt;, Func&lt;TParams, EventContext, Task&gt;, Boolean)</a>
-                </div>
-                <div>
-                  <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnConnect">ProtocolEndpoint.OnConnect()</a>
-                </div>
-                <div>
-                  <a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.ProtocolEndpoint.html#Microsoft_SqlTools_ServiceLayer_Hosting_Protocol_ProtocolEndpoint_OnStop">ProtocolEndpoint.OnStop()</a>
-                </div>
-                <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.Hosting</h6>
              <h6><strong>Assembly</strong>:Microsoft.SqlTools.ServiceLayer.dll</h6>
              <h5 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_syntax">Syntax</h5>
@@ -161,7 +101,6 @@ handlers that are registered prior to startup.</p>
              <span class="small pull-right mobile-hide">
                <a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/ServiceHost.cs/#L41">View Source</a>
              </span>
-              <a id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_Instance_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.Instance*"></a>
              <h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_Instance" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.Instance">Instance</h4>
              <div class="markdown level1 summary"><p>Current instance of the ServiceHost</p>
 </div>
@@ -170,7 +109,7 @@ handlers that are registered prior to startup.</p>
              <div class="codewrapper">
                <pre><code class="lang-csharp hljs">public static ServiceHost Instance { 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>
@@ -194,7 +133,6 @@ handlers that are registered prior to startup.</p>
              <span class="small pull-right mobile-hide">
                <a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/ServiceHost.cs/#L60">View Source</a>
              </span>
-              <a id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_Initialize_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.Initialize*"></a>
              <h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_Initialize" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.Initialize">Initialize()</h4>
              <div class="markdown level1 summary"><p>Provide initialization that must occur after the service host is started</p>
 </div>
@@ -210,7 +148,6 @@ handlers that are registered prior to startup.</p>
              <span class="small pull-right mobile-hide">
                <a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/ServiceHost.cs/#L109">View Source</a>
              </span>
-              <a id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_RegisterInitializeTask_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.RegisterInitializeTask*"></a>
              <h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_RegisterInitializeTask_Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_InitializeCallback_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.RegisterInitializeTask(Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.InitializeCallback)">RegisterInitializeTask(ServiceHost.InitializeCallback)</h4>
              <div class="markdown level1 summary"><p>Add a new method to be called when the initialize request is submitted</p>
 </div>
@@ -231,7 +168,7 @@ handlers that are registered prior to startup.</p>
                <tbody>
                  <tr>
                    <td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.InitializeCallback.html">ServiceHost.InitializeCallback</a></td>
-                    <td><span class="parametername">callback</span></td>
+                    <td><em>callback</em></td>
                    <td><p>Callback to perform when an initialize request is submitted</p>
 </td>
                  </tr>
@@ -244,7 +181,6 @@ handlers that are registered prior to startup.</p>
              <span class="small pull-right mobile-hide">
                <a href="https://github.com/Microsoft/sqltoolsservice/blob/master/src/Microsoft.SqlTools.ServiceLayer/Hosting/ServiceHost.cs/#L100">View Source</a>
              </span>
-              <a id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_RegisterShutdownTask_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.RegisterShutdownTask*"></a>
              <h4 id="Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_RegisterShutdownTask_Microsoft_SqlTools_ServiceLayer_Hosting_ServiceHost_ShutdownCallback_" data-uid="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.RegisterShutdownTask(Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.ShutdownCallback)">RegisterShutdownTask(ServiceHost.ShutdownCallback)</h4>
              <div class="markdown level1 summary"><p>Adds a new callback to be called when the shutdown request is submitted</p>
 </div>
@@ -265,7 +201,7 @@ handlers that are registered prior to startup.</p>
                <tbody>
                  <tr>
                    <td><a class="xref" href="Microsoft.SqlTools.ServiceLayer.Hosting.ServiceHost.ShutdownCallback.html">ServiceHost.ShutdownCallback</a></td>
-                    <td><span class="parametername">callback</span></td>
+                    <td><em>callback</em></td>
                    <td><p>Callback to perform when a shutdown request is submitted</p>
 </td>
                  </tr>
@@ -295,16 +231,9 @@ handlers that are registered prior to startup.</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>