Added XML docs after initial implementation

Author: droyad

src/dbup-clickhouse/ClickHouseConnectionManager.cs

@@ -12,7 +12,7 @@ namespace DbUp.ClickHouse;
 public class ClickHouseConnectionManager : DatabaseConnectionManager
 {
     /// <summary>
-    /// Creates a new ClickHouse database connection.
+    /// Initializes a new instance of the <see cref="ClickHouseConnectionManager"/> class.
     /// </summary>
     /// <param name="connectionString">The ClickHouse connection string.</param>
     public ClickHouseConnectionManager(string connectionString)
@@ -29,6 +29,7 @@ private static IDbConnection CreateConnection(string connectionString)
     /// Splits the statements in the script using proper SQL parsing that handles comments and string literals.
     /// </summary>
     /// <param name="scriptContents">The contents of the script to split.</param>
+    /// <returns>A collection of individual SQL statements.</returns>
     public override IEnumerable<string> SplitScriptIntoCommands(string scriptContents)
     {
         var statements = ClickHouseQueryParser.ParseRawQuery(scriptContents);

src/dbup-clickhouse/ClickHouseExtensions.cs

@@ -8,18 +8,61 @@ namespace DbUp.ClickHouse;
 /// </summary>
 public static class ClickHouseExtensions
 {
+    /// <summary>
+    /// Creates an upgrader for ClickHouse databases.
+    /// </summary>
+    /// <param name="supported">Fluent helper type.</param>
+    /// <param name="connectionString">The connection string.</param>
+    /// <returns>
+    /// A builder for a database upgrader designed for ClickHouse databases.
+    /// </returns>
     public static UpgradeEngineBuilder ClickHouseDatabase(this SupportedDatabases supported, string connectionString)
         => ClickHouseDatabase(supported, connectionString, null);
 
+    /// <summary>
+    /// Creates an upgrader for ClickHouse databases.
+    /// </summary>
+    /// <param name="supported">Fluent helper type.</param>
+    /// <param name="connectionString">The connection string.</param>
+    /// <param name="database">The ClickHouse database name to use.</param>
+    /// <returns>
+    /// A builder for a database upgrader designed for ClickHouse databases.
+    /// </returns>
     public static UpgradeEngineBuilder ClickHouseDatabase(this SupportedDatabases supported, string connectionString, string database)
         => ClickHouseDatabase(new ClickHouseConnectionManager(connectionString), database);
 
+    /// <summary>
+    /// Creates an upgrader for ClickHouse databases.
+    /// </summary>
+    /// <param name="supported">Fluent helper type.</param>
+    /// <param name="connectionManager">The <see cref="IConnectionManager"/> to be used during a database
+    /// upgrade. See <see cref="ClickHouseConnectionManager"/> for an example implementation</param>
+    /// <returns>
+    /// A builder for a database upgrader designed for ClickHouse databases.
+    /// </returns>
     public static UpgradeEngineBuilder ClickHouseDatabase(this SupportedDatabases supported, IConnectionManager connectionManager)
         => ClickHouseDatabase(connectionManager);
 
+    /// <summary>
+    /// Creates an upgrader for ClickHouse databases.
+    /// </summary>
+    /// <param name="connectionManager">The <see cref="IConnectionManager"/> to be used during a database
+    /// upgrade. See <see cref="ClickHouseConnectionManager"/> for an example implementation</param>
+    /// <returns>
+    /// A builder for a database upgrader designed for ClickHouse databases.
+    /// </returns>
     public static UpgradeEngineBuilder ClickHouseDatabase(IConnectionManager connectionManager)
         => ClickHouseDatabase(connectionManager, null);
 
+    /// <summary>
+    /// Creates an upgrader for ClickHouse databases.
+    /// </summary>
+    /// <param name="connectionManager">The <see cref="IConnectionManager"/> to be used during a database
+    /// upgrade. See <see cref="ClickHouseConnectionManager"/> for an example implementation</param>
+    /// <param name="schema">The database name to use.</param>
+    /// <returns>
+    /// A builder for a database upgrader designed for ClickHouse databases.
+    /// </returns>
     public static UpgradeEngineBuilder ClickHouseDatabase(IConnectionManager connectionManager, string schema)
     {
         var builder = new UpgradeEngineBuilder();
@@ -30,6 +73,13 @@ public static UpgradeEngineBuilder ClickHouseDatabase(IConnectionManager connect
         return builder;
     }
 
+    /// <summary>
+    /// Tracks the list of executed scripts in a ClickHouse table.
+    /// </summary>
+    /// <param name="builder">The builder.</param>
+    /// <param name="schema">The database.</param>
+    /// <param name="table">The table.</param>
+    /// <returns></returns>
     public static UpgradeEngineBuilder JournalToClickHouseTable(this UpgradeEngineBuilder builder, string schema, string table)
     {
         builder.Configure(c => c.Journal = new ClickHouseJournal(() => c.ConnectionManager, () => c.Log, schema, table));

src/dbup-clickhouse/ClickHouseJournal.cs

@@ -5,10 +5,18 @@
 namespace DbUp.ClickHouse;
 
 /// <summary>
-/// Tracks the list of executed scripts in a ClickHouse table.
+/// An implementation of the <see cref="Engine.IJournal"/> interface which tracks version numbers for a
+/// ClickHouse database using a table called schemaversions.
 /// </summary>
 public class ClickHouseJournal : TableJournal
 {
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ClickHouseJournal"/> class.
+    /// </summary>
+    /// <param name="connectionManager">The connection manager.</param>
+    /// <param name="logger">The log.</param>
+    /// <param name="schema">The database that contains the table.</param>
+    /// <param name="tableName">The table name.</param>
     public ClickHouseJournal(
         System.Func<IConnectionManager> connectionManager,
         System.Func<IUpgradeLog> logger,
@@ -18,12 +26,15 @@ public ClickHouseJournal(
     {
     }
 
+    /// <inheritdoc/>
     protected override string GetInsertJournalEntrySql(string scriptName, string applied)
         => $"INSERT INTO {FqSchemaTableName} (ScriptName, Applied) VALUES ({scriptName}, {applied})";
 
+    /// <inheritdoc/>
     protected override string GetJournalEntriesSql()
         => $"SELECT ScriptName FROM {FqSchemaTableName} ORDER BY ScriptName";
 
+    /// <inheritdoc/>
     protected override string CreateSchemaTableSql(string quotedPrimaryKeyName)
         => $"""
             CREATE TABLE {FqSchemaTableName}
@@ -34,6 +45,8 @@ Applied DateTime
             ENGINE = MergeTree()
             ORDER BY (ScriptName)
             """;
+    
+    /// <inheritdoc/>
     protected override string DoesTableExistSql()
     {
         return string.IsNullOrEmpty(SchemaTableSchema)

src/dbup-clickhouse/ClickHouseObjectParser.cs

@@ -5,5 +5,14 @@ namespace DbUp.ClickHouse;
 /// <summary>
 /// Parses SQL Objects and performs quoting functions for ClickHouse.
 /// </summary>
-public class ClickHouseObjectParser() : SqlObjectParser("`", "`");
+public class ClickHouseObjectParser : SqlObjectParser
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ClickHouseObjectParser"/> class.
+    /// </summary>
+    public ClickHouseObjectParser()
+        : base("`", "`")
+    {
+    }
+}
 

src/dbup-clickhouse/ClickHousePreprocessor.cs

@@ -7,6 +7,11 @@ namespace DbUp.ClickHouse;
 /// </summary>
 public class ClickHousePreprocessor : IScriptPreprocessor
 {
+    /// <summary>
+    /// Processes the script contents. This implementation returns the contents unchanged.
+    /// </summary>
+    /// <param name="contents">The script contents to process.</param>
+    /// <returns>The processed script contents.</returns>
     public string Process(string contents) => contents;
 }
 

src/dbup-clickhouse/ClickHouseScriptExecutor.cs

@@ -14,6 +14,12 @@ public class ClickHouseScriptExecutor : ScriptExecutor
     /// <summary>
     /// Initializes an instance of the <see cref="ClickHouseScriptExecutor"/> class.
     /// </summary>
+    /// <param name="connectionManagerFactory"></param>
+    /// <param name="log">The logging mechanism.</param>
+    /// <param name="schema">The database 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>
     public ClickHouseScriptExecutor(
         Func<IConnectionManager> connectionManagerFactory,
         Func<IUpgradeLog> log,
@@ -25,9 +31,11 @@ public ClickHouseScriptExecutor(
     {
     }
 
+    /// <inheritdoc/>
     protected override string GetVerifySchemaSql(string schema)
         => $"CREATE DATABASE IF NOT EXISTS {schema}";
 
+    /// <inheritdoc/>
     protected override void ExecuteCommandsWithinExceptionHandler(int index, SqlScript script, Action executeCommand)
     {
         try