wagesj45/cs-mic
1
0
Fork 0
Code Issues Pull requests Releases Packages 2 Wiki Activity Actions

Establishing XMLDoc conventions

Browse source
This commit is contained in:
Jordan Wages 2026-06-24 13:10:29 -05:00
commit 4072775c09
2 changed files with 53 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
src/StandardLibrary/functions/Sign.cs
View file

@ -3,11 +3,16 @@
namespace CSMic.StandardLibrary.Functions
{
/// <summary> A function that returns <c>1</c> if the expression is positive and <c>-1</c> if it is negative. </summary>
public class Sign : FunctionBase, ICodedFunction
{
/// <summary> (Immutable) The return value representing "positive". </summary>
private const decimal POSITIVE = 1;
/// <summary> (Immutable) The return value representing "negative". </summary>
private const decimal NEGATIVE = -1;
/// <summary> Gets the name of the function. </summary>
/// <value> sign. </value>
public string Name
{
get
@ -16,6 +21,8 @@ namespace CSMic.StandardLibrary.Functions
}
}
/// <summary> Gets the expected arguments. </summary>
/// <value> The expected arguments. </value>
public override IEnumerable<FunctionArgument> ExpectedArguments
{
get
@ -24,6 +31,9 @@ namespace CSMic.StandardLibrary.Functions
}
}
/// <summary> Executes the function with the given arguments. </summary>
/// <param name="args"> A variable-length parameters list containing arguments. </param>
/// <returns> A <see cref="FunctionValue"/> representing the result of the function execution. </returns>
public FunctionValue Execute(params FunctionArgument[] args)
{
return base.Execute(args, (_args) =>