docs: add missing testFramework xml documentation

microsoft · Nov 6, 2023 · bc7e5c7 · bc7e5c7
1 parent 8190287
commit bc7e5c7
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/src/AzureDataFactory.TestingFramework/Models/Pipelines/Pipeline.cs b/src/AzureDataFactory.TestingFramework/Models/Pipelines/Pipeline.cs
@@ -26,8 +26,8 @@ public PipelineActivity GetActivityByName(string activityName)
     /// Validates whether the list of parameters are complete and not duplicate.
     /// </summary>
     /// <param name="parameters"></param>
-    /// <exception cref="PipelineParameterNotProvidedException"></exception>
-    /// <exception cref="PipelineDuplicateParameterProvidedException"></exception>
+    /// <exception cref="PipelineParameterNotProvidedException">Thrown if a required pipeline parameter is not required</exception>
+    /// <exception cref="PipelineDuplicateParameterProvidedException">Thrown if a pipeline parameter is provided more than once</exception>
     internal void ValidateParameters(List<IRunParameter> parameters)
     {
         //Check if all parameters are provided

diff --git a/src/AzureDataFactory.TestingFramework/Models/TestFramework.cs b/src/AzureDataFactory.TestingFramework/Models/TestFramework.cs
@@ -46,19 +46,31 @@ public ActivityEnumerator EvaluateWithEnumerator(Pipeline pipeline, List<IRunPar
     /// </summary>
     /// <param name="pipeline">The pipeline to evaluate.</param>
     /// <param name="parameters">The global and regular parameters to be used for evaluating expressions.</param>
-    /// <returns></returns>
+    /// <returns>A list of evaluated pipeline activities</returns>
     /// <exception cref="PipelineParameterNotProvidedException">Thrown if a required pipeline parameter is not required</exception>
     /// <exception cref="PipelineDuplicateParameterProvidedException">Thrown if a pipeline parameter is provided more than once</exception>
     public List<PipelineActivity> EvaluateAll(Pipeline pipeline, List<IRunParameter> parameters)
     {
         return Evaluate(pipeline, parameters).ToList();
     }
 
+    /// <summary>
+    /// Evaluates a single activity given a state. Any expression part of the activity is evaluated based on the state of the pipeline.
+    /// </summary>
+    /// <param name="activity">The activity to evaluate</param>
+    /// <param name="state">The state which will be used to evaluate the expressions</param>
+    /// <returns>A list of evaluated pipelines, which can be more than 1 due to possible child activities.</returns>
     public IEnumerable<PipelineActivity> Evaluate(PipelineActivity activity, PipelineRunState state)
     {
         return Evaluate(new List<PipelineActivity> { activity }, state);
     }
 
+    /// <summary>
+    /// Evaluates all given activities using the provided parameters. The order of activity execution is simulated based on the dependencies. Any expression part of the activity is evaluated based on the state of the pipeline.
+    /// </summary>
+    /// <param name="activities">The activities to evaluate</param>
+    /// <param name="state">The state which will be used to evaluate the expressions</param>
+    /// <returns>A list of evaluated pipelines</returns>
     public IEnumerable<PipelineActivity> Evaluate(List<PipelineActivity> activities, PipelineRunState state)
     {
         while (state.ScopedPipelineActivityResults.Count != activities.Count)