Skip to content

Commit c451213

Browse files
committed
Add some comments
1 parent e7c8869 commit c451213

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

CodingSeb.ExpressionEvaluator/ExpressionEvaluator.cs

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4773,6 +4773,10 @@ public partial class VariableEvaluationEventArg : EventArgs
47734773
/// Constructor of the VariableEvaluationEventArg
47744774
/// </summary>
47754775
/// <param name="name">The name of the variable to Evaluate</param>
4776+
/// <param name="evaluator">The <see cref="ExpressionEvaluator"/> that detected the variable, field or property to evaluate</param>
4777+
/// <param name="onInstance">The object instance on which to evaluate the field or property (will be <see cref="This"/>)</param>
4778+
/// <param name="genericTypes">The generics types specified when at property access</param>
4779+
/// <param name="evaluateGenericTypes">A func to evaluate the list of specific types given between &lt; and &gt;</param>
47764780
public VariableEvaluationEventArg(string name, ExpressionEvaluator evaluator = null, object onInstance = null, string genericTypes = null, Func<string, Type[]> evaluateGenericTypes = null)
47774781
{
47784782
Name = name;
@@ -4840,23 +4844,40 @@ public Type[] EvaluateGenericTypes()
48404844
}
48414845
}
48424846

4847+
/// <summary>
4848+
/// Infos about the expression that has been/will be evaluated
4849+
/// </summary>
48434850
public partial class ExpressionEvaluationEventArg : EventArgs
48444851
{
48454852
private object value;
48464853

4854+
/// <summary>
4855+
/// Constructor of ExpressionEvaluationEventArg (for <see cref="ExpressionEvaluator.ExpressionEvaluating"/> event)
4856+
/// </summary>
4857+
/// <param name="expression">The expression that will be evaluated</param>
4858+
/// <param name="evaluator">The evaluator that will be use to evaluate the expression</param>
48474859
public ExpressionEvaluationEventArg(string expression, ExpressionEvaluator evaluator)
48484860
{
48494861
Expression = expression;
48504862
Evaluator = evaluator;
48514863
}
48524864

4865+
/// <summary>
4866+
/// Constructor of ExpressionEvaluationEventArg (for <see cref="ExpressionEvaluator.ExpressionEvaluated"/> event)
4867+
/// </summary>
4868+
/// <param name="expression">The expression that will be evaluated</param>
4869+
/// <param name="evaluator"></param>
4870+
/// <param name="value"></param>
48534871
public ExpressionEvaluationEventArg(string expression, ExpressionEvaluator evaluator, object value)
48544872
{
48554873
Expression = expression;
48564874
Evaluator = evaluator;
48574875
this.value = value;
48584876
}
48594877

4878+
/// <summary>
4879+
/// The evaluator that has been/will be use to evaluate the expression
4880+
/// </summary>
48604881
public ExpressionEvaluator Evaluator { get; }
48614882

48624883
/// <summary>
@@ -4866,7 +4887,8 @@ public ExpressionEvaluationEventArg(string expression, ExpressionEvaluator evalu
48664887
public string Expression { get; set; }
48674888

48684889
/// <summary>
4869-
/// To set the return of the evaluation
4890+
/// To set the return of the evaluation<para/>
4891+
/// IN the case of <see cref="ExpressionEvaluator.ExpressionEvaluated"/> event, store the result of the evaluation
48704892
/// </summary>
48714893
public object Value
48724894
{
@@ -4907,6 +4929,15 @@ public partial class FunctionEvaluationEventArg : EventArgs
49074929
private readonly Func<string, Type[]> evaluateGenericTypes;
49084930
private readonly string genericTypes;
49094931

4932+
/// <summary>
4933+
/// Constructor of the <see cref="FunctionEvaluationEventArg"/>
4934+
/// </summary>
4935+
/// <param name="name">The name of the function or method</param>
4936+
/// <param name="args">Arguments passed to fthe function or method</param>
4937+
/// <param name="evaluator">The <see cref="ExpressionEvaluator"/> that detected the function or method to evaluate</param>
4938+
/// <param name="onInstance">The object instance on which to evaluate the method (will be <see cref="This"/>)</param>
4939+
/// <param name="genericTypes">The generics types specified when at function calling</param>
4940+
/// <param name="evaluateGenericTypes">A func to evaluate the list of specific types given between &lt; and &gt;</param>
49104941
public FunctionEvaluationEventArg(string name, List<string> args = null, ExpressionEvaluator evaluator = null, object onInstance = null, string genericTypes = null, Func<string, Type[]> evaluateGenericTypes = null)
49114942
{
49124943
Name = name;

0 commit comments

Comments
 (0)