diff --git a/src/ServiceHost/Hosting/ServiceHost.cs b/src/ServiceHost/Hosting/ServiceHost.cs index fcaaffcd..dbc561fe 100644 --- a/src/ServiceHost/Hosting/ServiceHost.cs +++ b/src/ServiceHost/Hosting/ServiceHost.cs @@ -15,7 +15,9 @@ using Microsoft.SqlTools.ServiceLayer.Hosting.Protocol.Channel; namespace Microsoft.SqlTools.ServiceLayer.Hosting { /// - /// SQL Tools VS Code Language Server request handler + /// SQL Tools VS Code Language Server request handler. Provides the entire JSON RPC + /// implementation for sending/receiving JSON requests and dispatching the requests to + /// handlers that are registered prior to startup. /// public sealed class ServiceHost : ServiceHostBase { diff --git a/src/ServiceHost/LanguageServices/LanguageService.cs b/src/ServiceHost/LanguageServices/LanguageService.cs index 42bbdec5..d88cfd92 100644 --- a/src/ServiceHost/LanguageServices/LanguageService.cs +++ b/src/ServiceHost/LanguageServices/LanguageService.cs @@ -18,7 +18,8 @@ using System.Linq; namespace Microsoft.SqlTools.ServiceLayer.LanguageServices { /// - /// Main class for Language Service functionality + /// Main class for Language Service functionality including anything that reqires knowledge of + /// the language to perfom, such as definitions, intellisense, etc. /// public sealed class LanguageService { diff --git a/src/ServiceHost/Session/OutputType.cs b/src/ServiceHost/Session/OutputType.cs deleted file mode 100644 index 8ba866d7..00000000 --- a/src/ServiceHost/Session/OutputType.cs +++ /dev/null @@ -1,41 +0,0 @@ -// -// Copyright (c) Microsoft. All rights reserved. -// Licensed under the MIT license. See LICENSE file in the project root for full license information. -// - -namespace Microsoft.SqlTools.EditorServices -{ - /// - /// Enumerates the types of output lines that will be sent - /// to an IConsoleHost implementation. - /// - public enum OutputType - { - /// - /// A normal output line, usually written with the or Write-Host or - /// Write-Output cmdlets. - /// - Normal, - - /// - /// A debug output line, written with the Write-Debug cmdlet. - /// - Debug, - - /// - /// A verbose output line, written with the Write-Verbose cmdlet. - /// - Verbose, - - /// - /// A warning output line, written with the Write-Warning cmdlet. - /// - Warning, - - /// - /// An error output line, written with the Write-Error cmdlet or - /// as a result of some error during SqlTools pipeline execution. - /// - Error - } -} diff --git a/src/ServiceHost/Session/OutputWrittenEventArgs.cs b/src/ServiceHost/Session/OutputWrittenEventArgs.cs deleted file mode 100644 index 4b1dbbe3..00000000 --- a/src/ServiceHost/Session/OutputWrittenEventArgs.cs +++ /dev/null @@ -1,65 +0,0 @@ -// -// Copyright (c) Microsoft. All rights reserved. -// Licensed under the MIT license. See LICENSE file in the project root for full license information. -// - -using System; - -namespace Microsoft.SqlTools.EditorServices -{ - /// - /// Provides details about output that has been written to the - /// SqlTools host. - /// - public class OutputWrittenEventArgs - { - /// - /// Gets the text of the output. - /// - public string OutputText { get; private set; } - - /// - /// Gets the type of the output. - /// - public OutputType OutputType { get; private set; } - - /// - /// Gets a boolean which indicates whether a newline - /// should be written after the output. - /// - public bool IncludeNewLine { get; private set; } - - /// - /// Gets the foreground color of the output text. - /// - public ConsoleColor ForegroundColor { get; private set; } - - /// - /// Gets the background color of the output text. - /// - public ConsoleColor BackgroundColor { get; private set; } - - /// - /// Creates an instance of the OutputWrittenEventArgs class. - /// - /// The text of the output. - /// A boolean which indicates whether a newline should be written after the output. - /// The type of the output. - /// The foreground color of the output text. - /// The background color of the output text. - public OutputWrittenEventArgs( - string outputText, - bool includeNewLine, - OutputType outputType, - ConsoleColor foregroundColor, - ConsoleColor backgroundColor) - { - this.OutputText = outputText; - this.IncludeNewLine = includeNewLine; - this.OutputType = outputType; - this.ForegroundColor = foregroundColor; - this.BackgroundColor = backgroundColor; - } - } -} - diff --git a/src/ServiceHost/SqlContext/SqlToolsContext.cs b/src/ServiceHost/SqlContext/SqlToolsContext.cs index bf4d67c9..d110f28c 100644 --- a/src/ServiceHost/SqlContext/SqlToolsContext.cs +++ b/src/ServiceHost/SqlContext/SqlToolsContext.cs @@ -7,6 +7,9 @@ using System; namespace Microsoft.SqlTools.ServiceLayer.SqlContext { + /// + /// Context for SQL Tools + /// public class SqlToolsContext { /// diff --git a/src/ServiceHost/SqlContext/SqlToolsSettings.cs b/src/ServiceHost/SqlContext/SqlToolsSettings.cs index a6f242ed..07ea0ffe 100644 --- a/src/ServiceHost/SqlContext/SqlToolsSettings.cs +++ b/src/ServiceHost/SqlContext/SqlToolsSettings.cs @@ -3,6 +3,9 @@ using Microsoft.SqlTools.EditorServices.Utility; namespace Microsoft.SqlTools.ServiceLayer.SqlContext { + /// + /// Class for serialization and deserialization of the settings the SQL Tools Service needs. + /// public class SqlToolsSettings { // TODO: Is this needed? I can't make sense of this comment. @@ -30,6 +33,9 @@ namespace Microsoft.SqlTools.ServiceLayer.SqlContext } } + /// + /// Sub class for serialization and deserialization of script analysis settings + /// public class ScriptAnalysisSettings { public bool? Enable { get; set; } diff --git a/src/ServiceHost/WorkspaceServices/WorkspaceService.cs b/src/ServiceHost/WorkspaceServices/WorkspaceService.cs index 6eb0c8c9..a0b537a0 100644 --- a/src/ServiceHost/WorkspaceServices/WorkspaceService.cs +++ b/src/ServiceHost/WorkspaceServices/WorkspaceService.cs @@ -15,6 +15,14 @@ using Microsoft.SqlTools.ServiceLayer.WorkspaceServices.Contracts; namespace Microsoft.SqlTools.ServiceLayer.WorkspaceServices { + /// + /// Class for handling requests/events that deal with the state of the workspace, including the + /// opening and closing of files, the changing of configuration, etc. + /// + /// + /// The type of the class used for serializing and deserializing the configuration. Must be the + /// actual type of the instance otherwise deserialization will be incomplete. + /// public class WorkspaceService where TConfig : class, new() { @@ -135,9 +143,6 @@ namespace Microsoft.SqlTools.ServiceLayer.WorkspaceServices /// /// Handles text document change events /// - /// - /// - /// protected Task HandleDidChangeTextDocumentNotification( DidChangeTextDocumentParams textChangeParams, EventContext eventContext) @@ -187,8 +192,6 @@ namespace Microsoft.SqlTools.ServiceLayer.WorkspaceServices /// /// Handles the configuration change event /// - /// - /// protected async Task HandleDidChangeConfigurationNotification( DidChangeConfigurationParams configChangeParams, EventContext eventContext)