Joseph Doherty
eabf270d71
Resolve all 622 issues flagged by the enhanced CommentChecker: add missing <returns> tags (incl. the standard phrasing on non-generic Task methods), add missing <summary> tags, and replace misused/redundant <inheritdoc/> on members that override or implement nothing with real documentation. Documentation-only — no behavior change; solution builds clean.
43 lines
1.7 KiB
C#
43 lines
1.7 KiB
C#
using Microsoft.Extensions.DependencyInjection;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.SiteCallAudit;
|
|
|
|
/// <summary>
|
|
/// Composition root for the Site Call Audit (#22) component.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// Binds <see cref="SiteCallAuditOptions"/> (stuck-call detection + KPI
|
|
/// windowing for the read-side query/KPI handlers). The reconciliation puller
|
|
/// and central→site Retry/Discard relay are still deferred to later follow-ups.
|
|
/// </para>
|
|
/// <para>
|
|
/// The repository (<c>ISiteCallAuditRepository</c>) is registered by
|
|
/// <c>ZB.MOM.WW.ScadaBridge.ConfigurationDatabase.ServiceCollectionExtensions.AddConfigurationDatabase</c>,
|
|
/// so callers (the Host on the central node) must also call that. The actor's
|
|
/// <c>Props</c> are wired up in Host registration.
|
|
/// </para>
|
|
/// </remarks>
|
|
public static class ServiceCollectionExtensions
|
|
{
|
|
/// <summary>Configuration section bound to <see cref="SiteCallAuditOptions"/>.</summary>
|
|
public const string OptionsSection = "ScadaBridge:SiteCallAudit";
|
|
|
|
/// <summary>
|
|
/// Registers Site Call Audit (#22) services: the <see cref="SiteCallAuditOptions"/>
|
|
/// binding consumed by the actor's read-side KPI/query handlers. The actor's
|
|
/// <c>Props</c> are still constructed inline in Host wiring.
|
|
/// </summary>
|
|
/// <param name="services">The service collection to register into.</param>
|
|
/// <returns>The same <paramref name="services"/> collection, for chaining.</returns>
|
|
public static IServiceCollection AddSiteCallAudit(this IServiceCollection services)
|
|
{
|
|
ArgumentNullException.ThrowIfNull(services);
|
|
|
|
services.AddOptions<SiteCallAuditOptions>()
|
|
.BindConfiguration(OptionsSection);
|
|
|
|
return services;
|
|
}
|
|
}
|