docs: add XML documentation to NEW solution src files

Fix 173 of 175 documentation issues across 48 files using CommentChecker,
adding missing <summary>, <param>, and <inheritdoc /> tags to public APIs.
This commit is contained in:
Joseph Doherty
2026-01-27 06:19:20 -05:00
parent bfc1c8064a
commit 227a749cdf
53 changed files with 667 additions and 124 deletions
@@ -64,18 +64,20 @@ internal sealed class TransformingDataReader : IDataReader
public bool IsDBNull(int i) => _transformer.IsDBNull(i, _source);
/// <summary>
/// Gets the value of the column at the specified ordinal, applying transformations.
/// Gets the value of the column at the specified ordinal.
/// </summary>
/// <param name="i">The zero-based column ordinal.</param>
/// <returns>The transformed value of the column.</returns>
public object this[int i] => GetValue(i);
public object this[int i]
{
get => GetValue(i);
}
/// <summary>
/// Gets the value of the column with the specified name, applying transformations.
/// Gets the value of the column with the specified name.
/// </summary>
/// <param name="name">The name of the column.</param>
/// <returns>The transformed value of the column.</returns>
public object this[string name] => GetValue(GetOrdinal(name));
public object this[string name]
{
get => GetValue(GetOrdinal(name));
}
// Row navigation - delegated directly to source
/// <summary>
@@ -63,6 +63,9 @@ public class DataUpdateTask
/// <summary>
/// Creates a DataUpdateTask from an EtlPipelineConfig.
/// </summary>
/// <param name="pipeline">The ETL pipeline configuration.</param>
/// <param name="updateType">The type of update (Mass, Daily, or Hourly).</param>
/// <param name="minimumDt">Optional minimum datetime for incremental updates.</param>
public static DataUpdateTask FromPipeline(
EtlPipelineConfig pipeline,
UpdateTypes updateType,
@@ -46,6 +46,10 @@ public class PipelineRegistry : IPipelineRegistry
/// <summary>
/// Initializes a new instance of the <see cref="PipelineRegistry"/> class.
/// </summary>
/// <param name="options">Data sync configuration options.</param>
/// <param name="validator">Pipeline configuration validator.</param>
/// <param name="logger">Logger instance for diagnostics.</param>
/// <param name="environment">Host environment information.</param>
public PipelineRegistry(
IOptions<DataSyncOptions> options,
IPipelineValidator validator,
@@ -19,6 +19,10 @@ public class PipelineRegistryInitializer : IHostedService
/// <summary>
/// Initializes a new instance of the <see cref="PipelineRegistryInitializer"/> class.
/// </summary>
/// <param name="registry">The pipeline registry to initialize.</param>
/// <param name="options">Data sync configuration options.</param>
/// <param name="lifetime">Application lifetime management.</param>
/// <param name="logger">Logger instance for diagnostics.</param>
public PipelineRegistryInitializer(
IPipelineRegistry registry,
IOptions<DataSyncOptions> options,