Add XML doc comments

This commit is contained in:
codex 2026-06-24 14:17:32 -05:00
commit 80c2674070
37 changed files with 863 additions and 0 deletions

View file

@ -7,8 +7,18 @@ using System.Threading.Tasks;
namespace CSMic.StandardLibrary.Functions
{
/// <summary>
/// Represents the standard-library <c>min</c> function.
/// </summary>
/// <remarks>
/// The <c>min</c> function evaluates two numeric expressions and returns the smaller value.
/// </remarks>
public class Min : FunctionBase, ICodedFunction
{
/// <summary>
/// Gets the expression-language name used to invoke this function.
/// </summary>
/// <value><c>min</c>.</value>
public string Name
{
get
@ -17,6 +27,10 @@ namespace CSMic.StandardLibrary.Functions
}
}
/// <summary>
/// Gets the argument signature expected by the <c>min</c> function.
/// </summary>
/// <value>Two numeric arguments named <c>first</c> and <c>second</c>.</value>
public override IEnumerable<FunctionArgument> ExpectedArguments
{
get
@ -26,6 +40,15 @@ namespace CSMic.StandardLibrary.Functions
}
}
/// <summary>
/// Executes the <c>min</c> function.
/// </summary>
/// <param name="args">
/// The evaluated arguments supplied to the function. Exactly two numeric arguments are expected.
/// </param>
/// <returns>
/// A numeric <see cref="FunctionValue"/> containing the smaller of the two input values.
/// </returns>
public FunctionValue Execute(params FunctionArgument[] args)
{
return base.Execute(args, (_args) =>