comment cleanup

updated version to 0.5.0-230721-3

Author: Jani Giannoudis

Client.Scripting/Extensions.cs

@@ -2215,11 +2215,9 @@ public static object JsonToValue(this ValueType valueType, string json)
     }
 }
 
-/// <exclude />
 /// <summary><see cref="Tuple">Tuple</see> extension methods (internal usage)</summary>
 public static class TupleExtensions
 {
-    /// <exclude />
     /// <summary>Convert tuple values to case period values</summary>
     /// <param name="values">The tuple values</param>
     /// <returns>The period values</returns>
@@ -2239,7 +2237,6 @@ public static List<PeriodValue> TupleToPeriodValues(this List<Tuple<DateTime, Da
         return periodValues;
     }
 
-    /// <exclude />
     /// <summary>Convert tuple values to a case value</summary>
     /// <param name="values">The tuple values</param>
     /// <param name="caseFieldName">The case field name</param>
@@ -2253,7 +2250,6 @@ public static CasePayrollValue TupleToCasePeriodValue(this List<Tuple<DateTime,
         return new(caseFieldName, values.Select(x => new PeriodValue(x.Item1, x.Item2, x.Item3)));
     }
 
-    /// <exclude />
     /// <summary>Convert tuple values to case value</summary>
     /// <param name="value">The tuple value</param>
     /// <returns>The case period values</returns>
@@ -2266,7 +2262,6 @@ public static CaseValue TupleToCaseValue(this Tuple<string, DateTime, Tuple<Date
         return new(value.Item1, value.Item2, value.Item3.Item1, value.Item3.Item2, new(value.Item4), value.Item5, value.Item6, value.Item7);
     }
 
-    /// <exclude />
     /// <summary>Convert tuple values to case values</summary>
     /// <param name="values">The tuple values</param>
     /// <returns>The case period values</returns>
@@ -2286,7 +2281,6 @@ public static List<CaseValue> TupleToCaseValues(this List<Tuple<string, DateTime
         return caseValues;
     }
 
-    /// <exclude />
     /// <summary>Convert tuple values to a case value dictionary</summary>
     /// <param name="values">The values</param>
     /// <returns>The case values grouped by case field name</returns>
@@ -2301,7 +2295,6 @@ public static CasePayrollValueDictionary TupleToCaseValuesDictionary(this Dictio
         return new(caseValues);
     }
 
-    /// <exclude />
     /// <summary>Convert tuple values to a collector result</summary>
     /// <param name="values">The tuple values</param>
     /// <returns>The collector results</returns>
@@ -2316,7 +2309,6 @@ public static List<CollectorResult> TupleToCollectorResults(this List<Tuple<stri
             Attributes = x.Item5
         }));
 
-    /// <exclude />
     /// <summary>Convert tuple values to a collector custom result</summary>
     /// <param name="values">The tuple values</param>
     /// <returns>The collector custom results</returns>
@@ -2332,7 +2324,6 @@ public static List<CollectorCustomResult> TupleToCollectorCustomResults(this Lis
             Attributes = x.Item6
         }));
 
-    /// <exclude />
     /// <summary>Convert tuple values to a wage type result</summary>
     /// <param name="values">The tuple values</param>
     /// <returns>The wage type results</returns>
@@ -2348,7 +2339,6 @@ public static List<WageTypeResult> TupleToWageTypeResults(this List<Tuple<decima
             Attributes = x.Item6
         }));
 
-    /// <exclude />
     /// <summary>Convert tuple values to a wage type custom result</summary>
     /// <param name="values">The tuple values</param>
     /// <returns>The wage type custom results</returns>

Client.Scripting/Function/CaseAvailableFunction.cs

@@ -131,7 +131,8 @@ protected CaseAvailableFunction(string sourceFileName) :
     public string[] GetAvailableActions() =>
         Runtime.GetAvailableActions();
 
-    /// <exclude />
+    /// <summary>Entry point for the runtime</summary>
+    /// <remarks>Internal usage only, do not call this method</remarks>
     public bool? IsAvailable()
     {
         // case available actions

Client.Scripting/Function/CaseBuildFunction.cs

@@ -48,7 +48,8 @@ public string[] GetBuildActions() =>
     public string[] GetFieldBuildActions(string caseFieldName) =>
         Runtime.GetFieldBuildActions(caseFieldName);
 
-    /// <exclude />
+    /// <summary>Entry point for the runtime</summary>
+    /// <remarks>Internal usage only, do not call this method</remarks>
     public bool? Build()
     {
         InvokeCaseFieldActions();

Client.Scripting/Function/CaseRelationBuildFunction.cs

@@ -40,7 +40,8 @@ protected CaseRelationBuildFunction(string sourceFileName) :
     public string[] GetBuildActions() =>
         Runtime.GetBuildActions();
 
-    /// <exclude />
+    /// <summary>Entry point for the runtime</summary>
+    /// <remarks>Internal usage only, do not call this method</remarks>
     public bool? Build()
     {
         InvokeBuildActions();

Client.Scripting/Function/CaseRelationValidateFunction.cs

@@ -46,7 +46,8 @@ public void AddIssue(string message, int number = 0) =>
     public void AddIssue(string caseFieldName, string message, int number = 0) =>
         Runtime.AddIssue(caseFieldName, message, number);
 
-    /// <exclude />
+    /// <summary>Entry point for the runtime</summary>
+    /// <remarks>Internal usage only, do not call this method</remarks>
     public bool? Validate()
     {
         if (!InvokeValidateActions())

Client.Scripting/Function/CaseValidateFunction.cs

@@ -59,7 +59,8 @@ public void AddIssue(string message) =>
     public void AddIssue(string caseFieldName, string message) =>
         Runtime.AddIssue(caseFieldName, message);
 
-    /// <exclude />
+    /// <summary>Entry point for the runtime</summary>
+    /// <remarks>Internal usage only, do not call this method</remarks>
     public bool? Validate()
     {
         // case field validation

Client.Scripting/Function/CollectorApplyFunction.cs

@@ -53,7 +53,8 @@ protected CollectorApplyFunction(string sourceFileName) :
     /// <summary>The wage type result value</summary>
     public decimal WageTypeValue { get; }
 
-    /// <exclude />
+    /// <summary>Entry point for the runtime</summary>
+    /// <remarks>Internal usage only, do not call this method</remarks>
     public decimal? GetValue()
     {
         // ReSharper disable EmptyRegion

Client.Scripting/Function/CollectorEndFunction.cs

@@ -32,7 +32,8 @@ protected CollectorEndFunction(string sourceFileName) :
     /// <summary>Set collector values</summary>
     public void SetValues(decimal[] values) => Runtime.SetValues(values);
 
-    /// <exclude />
+    /// <summary>Entry point for the runtime</summary>
+    /// <remarks>Internal usage only, do not call this method</remarks>
     public object End()
     {
         // ReSharper disable EmptyRegion

Client.Scripting/Function/CollectorStartFunction.cs

@@ -32,7 +32,8 @@ protected CollectorStartFunction(string sourceFileName) :
     /// <summary>Set collector values</summary>
     public void SetValues(decimal[] values) => Runtime.SetValues(values);
 
-    /// <exclude />
+    /// <summary>Entry point for the runtime</summary>
+    /// <remarks>Internal usage only, do not call this method</remarks>
     public object Start()
     {
         // ReSharper disable EmptyRegion

Client.Scripting/Function/Function.cs

@@ -11,15 +11,12 @@ namespace PayrollEngine.Client.Scripting.Function;
 // ReSharper disable once PartialTypeWithSinglePart
 public abstract partial class Function : IDisposable
 {
-    /// <exclude />
     /// <summary>The function runtime</summary>
     protected dynamic Runtime { get; }
 
-    /// <exclude />
     /// <summary>The default namespace name for function actions</summary>
     public const string DefaultActionNamespace = "System";
 
-    /// <exclude />
     /// <summary>The input namespace name for function actions</summary>
     public const string InputActionNamespace = "Input";