Merge pull request #11 from DbUp/xml-doc

Add XML documentation for all public members

Author: droyad

src/dbup-redshift/RedshiftConnectionManager.cs

@@ -1,4 +1,4 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Linq;
 using System.Text.RegularExpressions;
 using DbUp.Engine.Transactions;
@@ -20,10 +20,7 @@ public RedshiftConnectionManager(string connectionString)
         {
         }
 
-        /// <summary>
-        /// Splits the statements in the script using the ";" character.
-        /// </summary>
-        /// <param name="scriptContents">The contents of the script to split.</param>
+        /// <inheritdoc/>
         public override IEnumerable<string> SplitScriptIntoCommands(string scriptContents)
         {
             var scriptStatements =

src/dbup-redshift/RedshiftObjectParser.cs

@@ -1,4 +1,4 @@
-using DbUp.Support;
+using DbUp.Support;
 
 namespace DbUp.Redshift
 {
@@ -7,6 +7,9 @@ namespace DbUp.Redshift
     /// </summary>
     public class RedshiftObjectParser : SqlObjectParser
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="RedshiftObjectParser"/> class.
+        /// </summary>
         public RedshiftObjectParser() : base("\"", "\"")
         {
         }

src/dbup-redshift/RedshiftScriptExecutor.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using DbUp.Engine;
 using DbUp.Engine.Output;
@@ -30,10 +30,12 @@ public RedshiftScriptExecutor(Func<IConnectionManager> connectionManagerFactory,
 
         }
 
+        /// <inheritdoc/>
         protected override string GetVerifySchemaSql(string schema)
            => $@"CREATE SCHEMA IF NOT EXISTS {schema}";
 
 
+        /// <inheritdoc/>
         protected override void ExecuteCommandsWithinExceptionHandler(int index, SqlScript script, Action excuteCommand)
         {
             try

src/dbup-redshift/RedshiftTableJournal.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using DbUp.Engine;
 using DbUp.Engine.Output;
 using DbUp.Engine.Transactions;
@@ -24,16 +24,19 @@ public RedshiftTableJournal(Func<IConnectionManager> connectionManager, Func<IUp
         {
         }
 
+        /// <inheritdoc/>
         protected override string GetInsertJournalEntrySql(string @scriptName, string @applied)
         {
             return $"insert into {FqSchemaTableName} (ScriptName, Applied) values ({@scriptName}, {@applied})";
         }
 
+        /// <inheritdoc/>
         protected override string GetJournalEntriesSql()
         {
             return $"select ScriptName from {FqSchemaTableName} order by ScriptName";
         }
 
+        /// <inheritdoc/>
         protected override string CreateSchemaTableSql(string quotedPrimaryKeyName)
         {
             return

src/dbup-redshift/dbup-redshift.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
         <Description>DbUp makes it easy to deploy and upgrade SQL Server databases. This package adds Amazon Redshift support.</Description>
@@ -12,6 +12,7 @@
         <Product>dbup_redshift</Product>
         <PackageId>dbup-redshift</PackageId>
         <PackageIcon>dbup-icon.png</PackageIcon>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
     </PropertyGroup>
 
     <PropertyGroup Condition="'$(CI)' == 'true'">