From 13d745dcaa840baf978594ead03425c8aad85305 Mon Sep 17 00:00:00 2001 From: Sipke Schoorstra Date: Sun, 11 Dec 2022 22:15:56 +0100 Subject: [PATCH] Add XML comments to WorkflowExecutionContext --- .../Models/WorkflowExecutionContext.cs | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/modules/Elsa.Workflows.Core/Models/WorkflowExecutionContext.cs b/src/modules/Elsa.Workflows.Core/Models/WorkflowExecutionContext.cs index 6fbb3b3dd..f2836105e 100644 --- a/src/modules/Elsa.Workflows.Core/Models/WorkflowExecutionContext.cs +++ b/src/modules/Elsa.Workflows.Core/Models/WorkflowExecutionContext.cs @@ -6,8 +6,17 @@ using Microsoft.Extensions.DependencyInjection; namespace Elsa.Workflows.Core.Models; +/// +/// A delegate entry that is used by activities to be notified when the activities they scheduled are completed. +/// +/// The activity scheduling the activity. +/// The child being scheduled. +/// The delegate to invoke when the scheduled activity completes. public record ActivityCompletionCallbackEntry(ActivityExecutionContext Owner, IActivity Child, ActivityCompletionCallback? CompletionCallback); +/// +/// Provides context to the currently executing workflow. +/// public class WorkflowExecutionContext { internal static ValueTask Complete(ActivityExecutionContext context) => context.CompleteActivityAsync(); @@ -16,6 +25,9 @@ public class WorkflowExecutionContext private readonly IList _completionCallbackEntries = new List(); private IList _activityExecutionContexts; + /// + /// Constructor. + /// public WorkflowExecutionContext( IServiceProvider serviceProvider, string id,