Skip to content

Commit 13d0e64

Browse files
📝 Add docstrings to LNK-4651-AddHic-Type-for-AdhocReportGeneration
Docstrings generation was requested by @arianamihailescu. * #1345 (comment) The following files were modified: * `DotNet/Report/Application/Factory/ScheduledReportFactory.cs` * `DotNet/Report/Listeners/GenerateReportListener.cs`
1 parent 700a410 commit 13d0e64

2 files changed

Lines changed: 11 additions & 2 deletions

File tree

DotNet/Report/Application/Factory/ScheduledReportFactory.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ namespace LantanaGroup.Link.Report.Application.Factory;
77

88
public class ScheduledReportFactory
99
{
10+
/// <summary>
11+
/// Create a ScheduledReportListSummary populated from the provided ReportSchedule domain model.
12+
/// </summary>
13+
/// <param name="reportScheduleModel">The domain ReportSchedule to map into a summary object.</param>
14+
/// <returns>A ScheduledReportListSummary with fields copied from <paramref name="reportScheduleModel"/>; `Id` is the empty string if the source Id is null, and `Submitted` is `true` when `SubmitReportDateTime` has a value.</returns>
1015
public ScheduledReportListSummary FromDomain(ReportSchedule reportScheduleModel)
1116
{
1217
return new ScheduledReportListSummary()

DotNet/Report/Listeners/GenerateReportListener.cs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using Confluent.Kafka;
1+
using Confluent.Kafka;
22
using Confluent.Kafka.Extensions.Diagnostics;
33
using Hl7.Fhir.Model;
44
using Hl7.Fhir.Serialization;
@@ -93,6 +93,10 @@ protected override Task ExecuteAsync(CancellationToken stoppingToken)
9393
}
9494

9595

96+
/// <summary>
97+
/// Runs the Kafka consumer loop that processes GenerateReportRequested messages to schedule or regenerate reports, create patient submission entries, and emit downstream events (evaluation requests or data-acquisition requests).
98+
/// </summary>
99+
/// <param name="cancellationToken">Token used to stop the consumer loop and cancel in-flight operations.</param>
96100
private async Task StartConsumerLoop(CancellationToken cancellationToken)
97101
{
98102
var config = new ConsumerConfig()
@@ -422,4 +426,4 @@ private static string GetFacilityIdFromHeader(Headers headers)
422426
return facilityId;
423427
}
424428
}
425-
}
429+
}

0 commit comments

Comments
 (0)