Adding docstrings (#1877)

* Adding docstrings

* merge from main

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/DatabaseReferences/AddDacpacReferenceParams.cs

@@ -21,6 +21,9 @@ namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
         public string DacpacPath { get; set; }
     }
 
+    /// <summary>
+    /// Add a dacpac reference to a project
+    /// </summary>
     public class AddDacpacReferenceRequest
     {
         public static readonly RequestType<AddDacpacReferenceParams, ResultStatus> Type = RequestType<AddDacpacReferenceParams, ResultStatus>.Create("sqlprojects/addDacpacReference");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/DatabaseReferences/AddSqlProjectReferenceParams.cs

@@ -26,7 +26,9 @@ namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
         public string ProjectGuid { get; set; }
     }
 
-
+    /// <summary>
+    /// Add a SQL Project reference to a project
+    /// </summary>
     public class AddSqlProjectReferenceRequest
     {
         public static readonly RequestType<AddSqlProjectReferenceParams, ResultStatus> Type = RequestType<AddSqlProjectReferenceParams, ResultStatus>.Create("sqlprojects/addSqlProjectReference");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/DatabaseReferences/AddSystemDatabaseReference.cs

@@ -20,6 +20,9 @@ namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
         public SystemDatabase SystemDatabase { get; set; }
     }
 
+    /// <summary>
+    /// Add a system database reference to a project
+    /// </summary>
     public class AddSystemDatabaseReferenceRequest
     {
         public static readonly RequestType<AddSystemDatabaseReferenceParams, ResultStatus> Type = RequestType<AddSystemDatabaseReferenceParams, ResultStatus>.Create("sqlprojects/addSystemDatabaseReference");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/DatabaseReferences/DeleteDatabaseReference.cs

@@ -21,6 +21,9 @@ namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
         public string Name { get; set; }
     }
 
+    /// <summary>
+    /// Delete a database reference from a project
+    /// </summary>
     public class DeleteDatabaseReferenceRequest
     {
         public static readonly RequestType<SqlProjectScriptParams, ResultStatus> Type = RequestType<SqlProjectScriptParams, ResultStatus>.Create("sqlprojects/deleteDatabaseReference");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/Folders/AddFolder.cs

@@ -21,6 +21,9 @@ namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
         public string Path { get; set; }
     }
 
+    /// <summary>
+    /// Add a folder to a project
+    /// </summary>
     public class AddFolderRequest
     {
         public static readonly RequestType<FolderParams, ResultStatus> Type = RequestType<FolderParams, ResultStatus>.Create("sqlProjects/addFolder");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/Folders/DeleteFolder.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.ServiceLayer.Utility;
 
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Delete a folder from a project
+    /// </summary>
     public class DeleteFolderRequest
     {
         public static readonly RequestType<FolderParams, ResultStatus> Type = RequestType<FolderParams, ResultStatus>.Create("sqlProjects/deleteFolder");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/PrePostDeploymentScripts/AddPostDeploymentScript.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.ServiceLayer.Utility;
 
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Add a post-deployment script to a project
+    /// </summary>
     public class AddPostDeploymentScriptRequest
     {
         public static readonly RequestType<SqlProjectScriptParams, ResultStatus> Type = RequestType<SqlProjectScriptParams, ResultStatus>.Create("sqlProjects/addPostDeploymentScript");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/PrePostDeploymentScripts/AddPreDeploymentScript.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.ServiceLayer.Utility;
 
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Add a pre-deployment script to a project
+    /// </summary>
     public class AddPreDeploymentScriptRequest
     {
         public static readonly RequestType<SqlProjectScriptParams, ResultStatus> Type = RequestType<SqlProjectScriptParams, ResultStatus>.Create("sqlProjects/addPreDeploymentScript");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/PrePostDeploymentScripts/DeletePostDeploymentScript.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.ServiceLayer.Utility;
 
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Delete a post-deployment script from a project
+    /// </summary>
     public class DeletePostDeploymentScriptRequest
     {
         public static readonly RequestType<SqlProjectScriptParams, ResultStatus> Type = RequestType<SqlProjectScriptParams, ResultStatus>.Create("sqlProjects/deletePostDeploymentScript");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/PrePostDeploymentScripts/DeletePreDeploymentScript.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.ServiceLayer.Utility;
 
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Delete a pre-deployment script from a project
+    /// </summary>
     public class DeletePreDeploymentScriptRequest
     {
         public static readonly RequestType<SqlProjectScriptParams, ResultStatus> Type = RequestType<SqlProjectScriptParams, ResultStatus>.Create("sqlProjects/deletePreDeploymentScript");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/PrePostDeploymentScripts/ExcludePostDeploymentScript.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.ServiceLayer.Utility;
 
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Exclude a post-deployment script from a project
+    /// </summary>
     public class ExcludePostDeploymentScriptRequest
     {
         public static readonly RequestType<SqlProjectScriptParams, ResultStatus> Type = RequestType<SqlProjectScriptParams, ResultStatus>.Create("sqlProjects/excludePostDeploymentScript");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/PrePostDeploymentScripts/ExcludePreDeploymentScript.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.ServiceLayer.Utility;
 
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Exclude a pre-deployment script from a project
+    /// </summary>
     public class ExcludePreDeploymentScriptRequest
     {
         public static readonly RequestType<SqlProjectScriptParams, ResultStatus> Type = RequestType<SqlProjectScriptParams, ResultStatus>.Create("sqlProjects/excludePreDeploymentScript");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/PrePostDeploymentScripts/MovePostDeploymentScript.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.ServiceLayer.Utility;
 
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Move a post-deployment script in a project
+    /// </summary>
     public class MovePostDeploymentScriptRequest
     {
         public static readonly RequestType<MoveItemParams, ResultStatus> Type = RequestType<MoveItemParams, ResultStatus>.Create("sqlProjects/movePostDeploymentScript");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/PrePostDeploymentScripts/MovePreDeploymentScript.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.Hosting.Protocol.Contracts;
 using Microsoft.SqlTools.ServiceLayer.Utility;
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Move a pre-deployment script in a project
+    /// </summary>
     public class MovePreDeploymentScriptRequest
     {
         public static readonly RequestType<MoveItemParams, ResultStatus> Type = RequestType<MoveItemParams, ResultStatus>.Create("sqlProjects/movePreDeploymentScript");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/Projects/CloseSqlProject.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.ServiceLayer.Utility;
 
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Close a SQL project
+    /// </summary>
     public class CloseSqlProjectRequest
     {
         public static readonly RequestType<SqlProjectParams, ResultStatus> Type = RequestType<SqlProjectParams, ResultStatus>.Create("sqlProjects/closeProject");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/Projects/CreateSqlProject.cs

@@ -10,7 +10,7 @@ using Microsoft.SqlTools.ServiceLayer.Utility;
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
     /// <summary>
-    /// Parameters for creating a new SQL Project
+    /// Parameters for creating a new SQL project
     /// </summary>
     public class CreateSqlProjectParams : SqlProjectParams
     {
@@ -32,6 +32,9 @@ namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
         public string? BuildSdkVersion { get; set; }
     }
 
+    /// <summary>
+    /// Create a new SQL project
+    /// </summary>
     public class CreateSqlProjectRequest
     {
         public static readonly RequestType<CreateSqlProjectParams, ResultStatus> Type = RequestType<CreateSqlProjectParams, ResultStatus>.Create("sqlProjects/createProject");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/Projects/GetCrossPlatformCompatibility.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.ServiceLayer.Utility;
 
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Get the cross-platform compatibility status for a project
+    /// </summary>
     public class GetCrossPlatformCompatiblityRequest
     {
         public static readonly RequestType<SqlProjectParams, GetCrossPlatformCompatiblityResult> Type = RequestType<SqlProjectParams, GetCrossPlatformCompatiblityResult>.Create("sqlProjects/getCrossPlatformCompatibility");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/Projects/OpenSqlProject.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.ServiceLayer.Utility;
 
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Open an existing SQL project
+    /// </summary>
     public class OpenSqlProjectRequest
     {
         public static readonly RequestType<SqlProjectParams, ResultStatus> Type = RequestType<SqlProjectParams, ResultStatus>.Create("sqlProjects/openProject");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/Projects/UpdateProjectForCrossPlatform.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.ServiceLayer.Utility;
 
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Update a SQL project to be cross-platform compatible
+    /// </summary>
     public class UpdateProjectForCrossPlatformRequest
     {
         public static readonly RequestType<SqlProjectParams, ResultStatus> Type = RequestType<SqlProjectParams, ResultStatus>.Create("sqlProjects/updateProjectForCrossPlatform");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/SqlCmdVariables/AddSqlCmdVariable.cs

@@ -31,6 +31,9 @@ namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
         public string Value { get; set; }
     }
 
+    /// <summary>
+    /// Add a SQLCMD variable to a project
+    /// </summary>
     public class AddSqlCmdVariableRequest
     {
         public static readonly RequestType<AddSqlCmdVariableParams, ResultStatus> Type = RequestType<AddSqlCmdVariableParams, ResultStatus>.Create("sqlProjects/addSqlCmdVariable");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/SqlCmdVariables/DeleteSqlCmdVariable.cs

@@ -19,6 +19,9 @@ namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
         public string? Name { get; set; }
     }
 
+    /// <summary>
+    /// Delete a SQLCMD variable from a project
+    /// </summary>
     public class DeleteSqlCmdVariableRequest
     {
         public static readonly RequestType<DeleteSqlCmdVariableParams, ResultStatus> Type = RequestType<DeleteSqlCmdVariableParams, ResultStatus>.Create("sqlProjects/deleteSqlCmdVariable");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/SqlCmdVariables/UpdateSqlCmdvariable.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.ServiceLayer.Utility;
 
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Update an existing SQLCMD variable in a project
+    /// </summary>
     public class UpdateSqlCmdVariableRequest
     {
         public static readonly RequestType<AddSqlCmdVariableParams, ResultStatus> Type = RequestType<AddSqlCmdVariableParams, ResultStatus>.Create("sqlProjects/updateSqlCmdVariable");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/SqlObjectScripts/AddSqlObjectScript.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.ServiceLayer.Utility;
 
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Add a SQL object script to a project
+    /// </summary>
     public class AddSqlObjectScriptRequest
     {
         public static readonly RequestType<SqlProjectScriptParams, ResultStatus> Type = RequestType<SqlProjectScriptParams, ResultStatus>.Create("sqlProjects/addSqlObjectScript");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/SqlObjectScripts/DeleteSqlObjectScript.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.Hosting.Protocol.Contracts;
 using Microsoft.SqlTools.ServiceLayer.Utility;
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Delete a SQL object script from a project
+    /// </summary>
     public class DeleteSqlObjectScriptRequest
     {
         public static readonly RequestType<SqlProjectScriptParams, ResultStatus> Type = RequestType<SqlProjectScriptParams, ResultStatus>.Create("sqlProjects/deleteSqlObjectScript");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/SqlObjectScripts/ExcludeSqlObjectScript.cs

@@ -8,6 +8,9 @@ using Microsoft.SqlTools.ServiceLayer.Utility;
 
 namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
 {
+    /// <summary>
+    /// Exclude a SQL object script from a project
+    /// </summary>
     public class ExcludeSqlObjectScriptRequest
     {
         public static readonly RequestType<SqlProjectScriptParams, ResultStatus> Type = RequestType<SqlProjectScriptParams, ResultStatus>.Create("sqlProjects/excludeSqlObjectScript");

src/Microsoft.SqlTools.ServiceLayer/SqlProjects/Contracts/SqlObjectScripts/MoveSqlObjectScript.cs

@@ -21,6 +21,9 @@ namespace Microsoft.SqlTools.ServiceLayer.SqlProjects.Contracts
         public string DestinationPath { get; set; } 
     }
 
+    /// <summary>
+    /// Move a SQL object script in a project
+    /// </summary>
     public class MoveSqlObjectScriptRequest
     {
         public static readonly RequestType<MoveItemParams, ResultStatus> Type = RequestType<MoveItemParams, ResultStatus>.Create("sqlProjects/moveSqlObjectScript");