Merge pull request #10 from DbUp/xml-doc

Add XML documentation for all public members

Author: droyad

src/dbup-firebird/FirebirdConnectionManager.cs

@@ -1,4 +1,4 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Linq;
 using System.Text.RegularExpressions;
 using DbUp.Engine.Transactions;
@@ -19,10 +19,7 @@ public class FirebirdConnectionManager : DatabaseConnectionManager
         {
         }
 
-        /// <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)
         {
             // TODO: Possible Change - this is the PostGres version
@@ -35,6 +32,7 @@ public override IEnumerable<string> SplitScriptIntoCommands(string scriptContent
             return scriptStatements;
         }
 
+        /// <inheritdoc/>
         protected override AllowedTransactionMode AllowedTransactionModes => AllowedTransactionMode.TransactionPerScript;
     }
 }

src/dbup-firebird/FirebirdObjectParser.cs

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

src/dbup-firebird/FirebirdScriptExecutor.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using DbUp.Engine;
 using DbUp.Engine.Output;
@@ -21,13 +21,14 @@ public class FirebirdScriptExecutor : ScriptExecutor
         /// <param name="schema">The schema that contains the table.</param>
         /// <param name="variablesEnabled">Function that returns <c>true</c> if variables should be replaced, <c>false</c> otherwise.</param>
         /// <param name="scriptPreprocessors">Script Preprocessors in addition to variable substitution</param>
-        /// <param name="journalFactory">Database journal</param>
+        /// <param name="journal">Database journal</param>
         public FirebirdScriptExecutor(Func<IConnectionManager> connectionManagerFactory, Func<IUpgradeLog> log, string schema, Func<bool> variablesEnabled,
             IEnumerable<IScriptPreprocessor> scriptPreprocessors, Func<IJournal> journal)
             : base(connectionManagerFactory, new FirebirdObjectParser(), log, schema, variablesEnabled, scriptPreprocessors, journal)
         {
         }
 
+        /// <inheritdoc/>
         protected override string GetVerifySchemaSql(string schema)
         {
             throw new NotSupportedException();
@@ -39,6 +40,7 @@ protected override string GetVerifySchemaSql(string schema)
         /// </summary>
         protected override bool UseTheSameTransactionForJournalTableAndScripts => false;
 
+        /// <inheritdoc/>
         protected override void ExecuteCommandsWithinExceptionHandler(int index, SqlScript script, Action executeCommand)
         {
             try

src/dbup-firebird/FirebirdTableJournal.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Data;
 using DbUp.Engine;
 using DbUp.Engine.Output;
@@ -51,6 +51,7 @@ void ExecuteCommand(Func<IDbCommand> dbCommandFactory, string sql)
             }
         }
 
+        /// <inheritdoc/>
         protected override void OnTableCreated(Func<IDbCommand> dbCommandFactory)
         {
             var unquotedTableName = UnquoteSqlObjectName(FqSchemaTableName);
@@ -60,21 +61,25 @@ protected override void OnTableCreated(Func<IDbCommand> dbCommandFactory)
             Log().LogInformation($"The {TriggerName(unquotedTableName)} trigger has been created");
         }
 
+        /// <inheritdoc/>
         protected override string DoesTableExistSql()
         {
             return $"select 1 from RDB$RELATIONS where RDB$SYSTEM_FLAG = 0 and RDB$RELATION_NAME = '{UnquotedSchemaTableName}'";
         }
 
+        /// <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-firebird/dbup-firebird.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 Firebird support.</Description>
@@ -15,6 +15,7 @@
     <RepositoryUrl>https://github.com/DbUp/dbup-firebird.git</RepositoryUrl>
     <PackageIcon>dbup-icon.png</PackageIcon>
     <PublicSign Condition=" '$(OS)' != 'Windows_NT' ">true</PublicSign>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(CI)' == 'true'">