Skip to content

Commit 5f2b78f

Browse files
committed
Add XML documentation for all public members
1 parent d1ae14b commit 5f2b78f

File tree

6 files changed

+18
-11
lines changed

6 files changed

+18
-11
lines changed

src/dbup-mysql/MySqlCommandReader.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using System;
1+
using System;
22
using System.Text;
33
using DbUp.Support;
44

@@ -21,13 +21,15 @@ public class MySqlCommandReader : SqlCommandReader
2121
/// <summary>
2222
/// Hook to support custom statements
2323
/// </summary>
24+
/// <inheritdoc/>
2425
protected override bool IsCustomStatement => TryPeek(DelimiterKeyword.Length - 1, out var statement) &&
2526
string.Equals(DelimiterKeyword, CurrentChar + statement, StringComparison.OrdinalIgnoreCase) &&
2627
string.IsNullOrEmpty(GetCurrentCommandTextFromBuffer());
2728

2829
/// <summary>
2930
/// Read a custom statement
3031
/// </summary>
32+
/// <inheritdoc/>
3133
protected override void ReadCustomStatement()
3234
{
3335
// Move past Delimiter keyword

src/dbup-mysql/MySqlConnectionManager.cs

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using System.Collections.Generic;
1+
using System.Collections.Generic;
22
using DbUp.Engine.Transactions;
33
using MySqlConnector;
44

@@ -18,11 +18,7 @@ public class MySqlConnectionManager : DatabaseConnectionManager
1818
{
1919
}
2020

21-
/// <summary>
22-
/// Splits the statements in the script using the ";" character or
23-
/// DELIMITER if specified.
24-
/// </summary>
25-
/// <param name="scriptContents">The contents of the script to split.</param>
21+
/// <inheritdoc/>
2622
public override IEnumerable<string> SplitScriptIntoCommands(string scriptContents)
2723
{
2824
var commandSplitter = new MySqlCommandSplitter();

src/dbup-mysql/MySqlObjectParser.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using DbUp.Support;
1+
using DbUp.Support;
22

33
namespace DbUp.MySql
44
{
@@ -7,6 +7,9 @@ namespace DbUp.MySql
77
/// </summary>
88
public class MySqlObjectParser : SqlObjectParser
99
{
10+
/// <summary>
11+
/// Initializes a new instance of the <see cref="MySqlObjectParser"/> class.
12+
/// </summary>
1013
public MySqlObjectParser() : base("`", "`")
1114
{
1215
}

src/dbup-mysql/MySqlScriptExecutor.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using System;
1+
using System;
22
using System.Collections.Generic;
33
using DbUp.Engine;
44
using DbUp.Engine.Output;
@@ -28,11 +28,13 @@ public MySqlScriptExecutor(Func<IConnectionManager> connectionManagerFactory, Fu
2828
{
2929
}
3030

31+
/// <inheritdoc/>
3132
protected override string GetVerifySchemaSql(string schema)
3233
{
3334
throw new NotSupportedException();
3435
}
3536

37+
/// <inheritdoc/>
3638
protected override void ExecuteCommandsWithinExceptionHandler(int index, SqlScript script, Action executeCommand)
3739
{
3840
try

src/dbup-mysql/MySqlTableJournal.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using System;
1+
using System;
22
using DbUp.Engine;
33
using DbUp.Engine.Output;
44
using DbUp.Engine.Transactions;
@@ -24,16 +24,19 @@ public MySqlTableJournal(Func<IConnectionManager> connectionManager, Func<IUpgra
2424
{
2525
}
2626

27+
/// <inheritdoc/>
2728
protected override string GetInsertJournalEntrySql(string @scriptName, string @applied)
2829
{
2930
return $"insert into {FqSchemaTableName} (ScriptName, Applied) values ({@scriptName}, {@applied})";
3031
}
3132

33+
/// <inheritdoc/>
3234
protected override string GetJournalEntriesSql()
3335
{
3436
return $"select scriptname from {FqSchemaTableName} order by scriptname";
3537
}
3638

39+
/// <inheritdoc/>
3740
protected override string CreateSchemaTableSql(string quotedPrimaryKeyName)
3841
{
3942
return

src/dbup-mysql/dbup-mysql.csproj

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Project Sdk="Microsoft.NET.Sdk">
1+
<Project Sdk="Microsoft.NET.Sdk">
22

33
<PropertyGroup>
44
<Description>DbUp makes it easy to deploy and upgrade SQL Server databases. This package adds MySql support.</Description>
@@ -14,6 +14,7 @@
1414
<SignAssembly>true</SignAssembly>
1515
<RepositoryUrl>https://github.com/DbUp/dbup-mysql.git</RepositoryUrl>
1616
<PackageIcon>dbup-icon.png</PackageIcon>
17+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
1718
</PropertyGroup>
1819

1920
<PropertyGroup Condition="'$(CI)' == 'true'">

0 commit comments

Comments
 (0)