chore: added better documentation

Author: deniszykov

Readme.md

@@ -43,10 +43,14 @@ public class ArgumentsTree : IDictionary<string, SyntaxTreeNode>
 		/// <summary>
 		///     Returns argument by its name.
 		/// </summary>
+		/// <param name="key">The name of the argument.</param>
+		/// <returns>The syntax tree node of the argument.</returns>
 		public SyntaxTreeNode this[string key] { get => this.innerDictionary[key]; set => throw new NotSupportedException(); }
 		/// <summary>
 		///     Returns argument by its position.
 		/// </summary>
+		/// <param name="position">The zero-based position of the argument.</param>
+		/// <returns>The syntax tree node of the argument.</returns>
 		public SyntaxTreeNode this[int position] { get => this.innerDictionary[Constants.GetIndexAsString(position)]; set => throw new NotSupportedException(); }
 
 		/// <summary>
@@ -66,7 +70,7 @@ private ArgumentsTree()
 		/// <summary>
 		///     Create list of arguments from existing dictionary.
 		/// </summary>
-		/// <param name="innerDictionary"></param>
+		/// <param name="innerDictionary">The dictionary containing the arguments.</param>
 		public ArgumentsTree(Dictionary<string, SyntaxTreeNode> innerDictionary)
 		{
 			if (innerDictionary == null) throw new ArgumentNullException(nameof(innerDictionary));
@@ -76,6 +80,7 @@ public ArgumentsTree(Dictionary<string, SyntaxTreeNode> innerDictionary)
 		/// <summary>
 		///     Check if passes positional argument is exists in list.
 		/// </summary>
+		/// <param name="position">The zero-based position of the argument.</param>
 		/// <returns>true is exists, overwise false.</returns>
 		public bool ContainsKey(int position)
 		{
@@ -84,6 +89,8 @@ public bool ContainsKey(int position)
 		/// <summary>
 		///     Tries to retrieve argument by its position.
 		/// </summary>
+		/// <param name="position">The zero-based position of the argument.</param>
+		/// <param name="value">When this method returns, contains the argument associated with the specified position, if the position is found; otherwise, null.</param>
 		/// <returns>true is exists, overwise false.</returns>
 		public bool TryGetValue(int position, out SyntaxTreeNode value)
 		{
@@ -93,13 +100,16 @@ public bool TryGetValue(int position, out SyntaxTreeNode value)
 		/// <summary>
 		///     Compares two arguments list by reference.
 		/// </summary>
+		/// <param name="obj">The object to compare with the current object.</param>
+		/// <returns>true if the specified object is equal to the current object; otherwise, false.</returns>
 		public override bool Equals(object obj)
 		{
 			return this.innerDictionary.Equals(obj);
 		}
 		/// <summary>
 		///     Returns hash code of arguments list.
 		/// </summary>
+		/// <returns>A hash code for the current object.</returns>
 		public override int GetHashCode()
 		{
 			return this.innerDictionary.GetHashCode();
@@ -108,6 +118,7 @@ public override int GetHashCode()
 		/// <summary>
 		///     Converts argument list to string.
 		/// </summary>
+		/// <returns>A string that represents the current object.</returns>
 		public override string ToString()
 		{
 			var sb = new StringBuilder();
@@ -129,6 +140,7 @@ void IDictionary<string, SyntaxTreeNode>.Add(string key, SyntaxTreeNode value)
 		/// <summary>
 		///     Check if passes named argument is exists in list.
 		/// </summary>
+		/// <param name="key">The name of the argument.</param>
 		/// <returns>true is exists, overwise false.</returns>
 		public bool ContainsKey(string key)
 		{
@@ -143,6 +155,8 @@ bool IDictionary<string, SyntaxTreeNode>.Remove(string key)
 		/// <summary>
 		///     Tries to retrieve argument by its name.
 		/// </summary>
+		/// <param name="key">The name of the argument.</param>
+		/// <param name="value">When this method returns, contains the argument associated with the specified name, if the name is found; otherwise, null.</param>
 		/// <returns>true is exists, overwise false.</returns>
 		public bool TryGetValue(string key, out SyntaxTreeNode value)
 		{

src/GameDevWare.Dynamic.Expressions.Unity.2021/Packages/com.gamedevware.csharpeval/Runtime/ArgumentsTree.cs

@@ -130,7 +130,7 @@ public Binder(IList<ParameterExpression> parameters, Type resultType, ITypeResol
 		/// </summary>
 		/// <param name="node">Syntax tree. Not null.</param>
 		/// <param name="global">Global object expression. Can be null. Usually <see cref="Expression.Constant(object)" />.</param>
-		/// <returns></returns>
+		/// <returns>A bound lambda expression.</returns>
 		public LambdaExpression Bind(SyntaxTreeNode node, Expression global = null)
 		{
 			if (node == null) throw new ArgumentNullException(nameof(node));

src/GameDevWare.Dynamic.Expressions.Unity.2021/Packages/com.gamedevware.csharpeval/Runtime/Binder.cs

@@ -207,13 +207,13 @@ public override string ToString()
 		private ParseTreeNodes nodes;
 
 		/// <summary>
-		///     Get child node by index.
+		///     Gets the child node at the specified index.
 		/// </summary>
-		/// <param name="index">Index of child node.</param>
-		/// <returns>Child node at index.</returns>
+		/// <param name="index">The zero-based index of the child node to get.</param>
+		/// <returns>The child node at the specified index.</returns>
 		public ParseTreeNode this[int index] => this.nodes[index];
 		/// <summary>
-		///     Returns number of child nodes.
+		///     Gets the number of child nodes.
 		/// </summary>
 		public int Count => this.nodes.Count;
 
@@ -283,25 +283,36 @@ public override string ToString()
 			return sb.ToString();
 		}
 
+		/// <summary>
+		///     Returns an enumerator that iterates through the child nodes.
+		/// </summary>
+		/// <returns>An enumerator for the child nodes.</returns>
 		IEnumerator<ParseTreeNode> IEnumerable<ParseTreeNode>.GetEnumerator()
 		{
 			for (var i = 0; i < this.nodes.Count; i++)
 				yield return this.nodes[i];
 		}
 
+		/// <summary>
+		///     Returns an enumerator that iterates through the child nodes.
+		/// </summary>
+		/// <returns>An enumerator for the child nodes.</returns>
 		IEnumerator IEnumerable.GetEnumerator()
 		{
 			return ((IEnumerable<ParseTreeNode>)this).GetEnumerator();
 		}
 
+		/// <inheritdoc />
 		int ILineInfo.GetLineNumber()
 		{
 			return this.Token.LineNumber;
 		}
+		/// <inheritdoc />
 		int ILineInfo.GetColumnNumber()
 		{
 			return this.Token.ColumnNumber;
 		}
+		/// <inheritdoc />
 		int ILineInfo.GetTokenLength()
 		{
 			return this.Token.TokenLength;

src/GameDevWare.Dynamic.Expressions.Unity.2021/Packages/com.gamedevware.csharpeval/Runtime/CSharp/ParseTreeNode.cs

@@ -3,8 +3,18 @@
 
 namespace GameDevWare.Dynamic.Expressions
 {
+	/// <summary>
+	///     Utility methods for working with delegates and reflection.
+	/// </summary>
 	public static class DelegateUtils
 	{
+		/// <summary>
+		///     Creates a delegate of the specified type from the specified <see cref="MethodInfo" />.
+		/// </summary>
+		/// <param name="delegateType">The type of the delegate to create. Cannot be null.</param>
+		/// <param name="method">The method to create the delegate for. Cannot be null.</param>
+		/// <param name="throwOnBindingFailure">True to throw an exception if the delegate cannot be bound; otherwise, false.</param>
+		/// <returns>The created delegate, or null if binding fails and <paramref name="throwOnBindingFailure" /> is false.</returns>
 		public static Delegate CreateDelegate(Type delegateType, MethodInfo method, bool throwOnBindingFailure = true)
 		{
 			if (delegateType == null) throw new ArgumentNullException(nameof(delegateType));
@@ -27,13 +37,23 @@ public static Delegate CreateDelegate(Type delegateType, MethodInfo method, bool
 #endif
 		}
 #if NETSTANDARD
+		/// <summary>
+		///     Gets the <see cref="MethodInfo" /> associated with the specified delegate instance.
+		/// </summary>
+		/// <param name="delegateInstance">The delegate instance. Cannot be null.</param>
+		/// <returns>The <see cref="MethodInfo" /> of the delegate.</returns>
 		public static MethodInfo GetMethodInfo(this Delegate delegateInstance)
 		{
 			if (delegateInstance == null) throw new ArgumentNullException(nameof(delegateInstance));
 
 			return RuntimeReflectionExtensions.GetMethodInfo(delegateInstance);
 		}
 #else
+		/// <summary>
+		///     Gets the <see cref="MethodInfo" /> associated with the specified delegate instance.
+		/// </summary>
+		/// <param name="delegateInstance">The delegate instance. Cannot be null.</param>
+		/// <returns>The <see cref="MethodInfo" /> of the delegate.</returns>
 		public static MethodInfo GetMethodInfo(this Delegate delegateInstance)
 		{
 			if (delegateInstance == null) throw new ArgumentNullException("delegateInstance");

src/GameDevWare.Dynamic.Expressions.Unity.2021/Packages/com.gamedevware.csharpeval/Runtime/DelegateUtils.cs

@@ -6,14 +6,30 @@
 
 namespace GameDevWare.Dynamic.Expressions
 {
+	/// <summary>
+	///     Provides methods for packing <see cref="Expression" /> trees into a serializable format and unpacking them back.
+	/// </summary>
 	public static class ExpressionPacker
 	{
+		/// <summary>
+		///     Packs the specified <see cref="Expression" /> into a dictionary-based serializable format.
+		/// </summary>
+		/// <param name="expression">The expression to pack. Cannot be null.</param>
+		/// <returns>A dictionary representation of the packed expression.</returns>
 		public static Dictionary<string, object> Pack(Expression expression)
 		{
 			if (expression == null) throw new ArgumentNullException(nameof(expression));
 
 			return AnyPacker.Pack(expression);
 		}
+		/// <summary>
+		///     Unpacks a packed expression from its dictionary-based format back into an <see cref="Expression" />.
+		/// </summary>
+		/// <param name="packedExpression">The dictionary containing the packed expression. Cannot be null.</param>
+		/// <param name="typeResolver">The type resolver to use for resolving types in the expression. Defaults to <see cref="KnownTypeResolver.Default"/>.</param>
+		/// <param name="global">The global object expression to use as a context. Can be null.</param>
+		/// <param name="expectedType">The expected result type of the expression. Defaults to <see cref="object"/>.</param>
+		/// <returns>The unpacked <see cref="Expression" />.</returns>
 		public static Expression Unpack
 			(IDictionary<string, object> packedExpression, ITypeResolver typeResolver = null, Expression global = null, Type expectedType = null)
 		{
@@ -31,6 +47,14 @@ public static Expression Unpack
 
 			return boundExpression;
 		}
+		/// <summary>
+		///     Unpacks a packed expression into a <see cref="LambdaExpression" /> with the specified delegate type.
+		/// </summary>
+		/// <param name="delegateType">The type of the delegate to create. Cannot be null.</param>
+		/// <param name="packedExpression">The dictionary containing the packed expression. Cannot be null.</param>
+		/// <param name="typeResolver">The type resolver to use for resolving types. Can be null.</param>
+		/// <param name="global">The global object expression to use as a context. Can be null.</param>
+		/// <returns>The unpacked <see cref="LambdaExpression" />.</returns>
 		public static LambdaExpression UnpackLambda
 			(Type delegateType, IDictionary<string, object> packedExpression, ITypeResolver typeResolver = null, Expression global = null)
 		{
@@ -42,6 +66,14 @@ public static LambdaExpression UnpackLambda
 			var unpackedExpression = binder.Bind(syntaxTree, global);
 			return unpackedExpression;
 		}
+		/// <summary>
+		///     Unpacks a packed expression into an <see cref="Expression{TDelegate}" /> of the specified delegate type.
+		/// </summary>
+		/// <typeparam name="DelegateT">The type of the delegate.</typeparam>
+		/// <param name="expressionTree">The dictionary containing the packed expression. Cannot be null.</param>
+		/// <param name="typeResolver">The type resolver to use for resolving types. Can be null.</param>
+		/// <param name="global">The global object expression to use as a context. Can be null.</param>
+		/// <returns>The unpacked <see cref="Expression{TDelegate}" />.</returns>
 		public static Expression<DelegateT> UnpackLambda<DelegateT>
 			(IDictionary<string, object> expressionTree, ITypeResolver typeResolver = null, Expression global = null)
 		{

src/GameDevWare.Dynamic.Expressions.Unity.2021/Packages/com.gamedevware.csharpeval/Runtime/ExpressionPacker.cs

@@ -112,7 +112,7 @@ int ILineInfo.GetTokenLength()
 		/// <summary>
 		///     Converts exception to string representation for debug purpose.
 		/// </summary>
-		/// <returns></returns>
+		/// <returns>A string that represents the current object.</returns>
 		public override string ToString()
 		{
 			if (this.TokenLength != 0)

src/GameDevWare.Dynamic.Expressions.Unity.2021/Packages/com.gamedevware.csharpeval/Runtime/ExpressionParserException.cs

@@ -45,7 +45,7 @@ public class SyntaxTreeNode : IDictionary<string, object>, ILineInfo
 		///     Returns contained node by its name;
 		/// </summary>
 		/// <param name="key">Name of contained node. Can't be null.</param>
-		/// <returns></returns>
+		/// <returns>The contained node associated with the specified key.</returns>
 		public object this[string key] { get => this.innerDictionary[key]; set => throw new NotSupportedException(); }
 
 		/// <summary>
@@ -91,7 +91,7 @@ private static Dictionary<string, object> PrepareNode(IDictionary<string, object
 		///     Default value node node with <paramref name="key" /> doesn't exists or value can't be casted
 		///     to <typeparamref name="T" />.
 		/// </param>
-		/// <returns>True is node exists and value successfully casted to <typeparamref name="T" />, overwise false.</returns>
+		/// <returns>The value of the node if it exists and can be cast to <typeparamref name="T" />; otherwise, <paramref name="defaultValue"/>.</returns>
 		public T GetValueOrDefault<T>(string key, T defaultValue = default)
 		{
 			var value = default(T);
@@ -531,13 +531,16 @@ internal string GetCSharpExpressionOrNull(bool throwOnError)
 		/// <summary>
 		///     Compares two syntax tree by reference.
 		/// </summary>
+		/// <param name="obj">The object to compare with the current object.</param>
+		/// <returns>true if the specified object is equal to the current object; otherwise, false.</returns>
 		public override bool Equals(object obj)
 		{
 			return this.innerDictionary.Equals(obj);
 		}
 		/// <summary>
 		///     Get hash code of syntax tree.
 		/// </summary>
+		/// <returns>A hash code for the current object.</returns>
 		public override int GetHashCode()
 		{
 			return this.innerDictionary.GetHashCode();
@@ -546,7 +549,7 @@ public override int GetHashCode()
 		/// <summary>
 		///     Format syntax tree as a C# expression. Throw exceptions if exception could not be formed.
 		/// </summary>
-		/// <returns>C# Expression.</returns>
+		/// <returns>C# Expression string.</returns>
 		public string ToCSharpExpression()
 		{
 			var expression = this.GetCSharpExpressionOrNull(false);
@@ -560,6 +563,7 @@ public string ToCSharpExpression()
 		/// <summary>
 		///     Format syntax tree as C# expression.
 		/// </summary>
+		/// <returns>A string that represents the current object.</returns>
 		public override string ToString()
 		{
 			try
@@ -589,6 +593,7 @@ void IDictionary<string, object>.Add(string key, object value)
 		///     Check if syntax tree contain node with specified <paramref name="key" />.
 		/// </summary>
 		/// <param name="key">Name of contained node. Can't be null.</param>
+		/// <returns>true if the syntax tree contains a node with the specified key; otherwise, false.</returns>
 		public bool ContainsKey(string key)
 		{
 			return this.innerDictionary.ContainsKey(key);
@@ -602,6 +607,8 @@ bool IDictionary<string, object>.Remove(string key)
 		/// <summary>
 		///     Tries to retrieve node of syntax tree by its name.
 		/// </summary>
+		/// <param name="key">The name of the node to retrieve.</param>
+		/// <param name="value">When this method returns, contains the node associated with the specified name, if the name is found; otherwise, null.</param>
 		/// <returns>True is node exists, overwise false.</returns>
 		public bool TryGetValue(string key, out object value)
 		{