Add XML doc comments
This commit is contained in:
parent
b911ccfbfe
commit
80c2674070
37 changed files with 863 additions and 0 deletions
|
|
@ -1,8 +1,18 @@
|
|||
namespace CSMic.StandardLibrary.Functions.Trigonometry
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents the standard-library <c>atan</c> function.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The <c>atan</c> function evaluates a numeric expression and returns its arctangent.
|
||||
/// </remarks>
|
||||
public class Atan : FunctionBase, ICodedFunction
|
||||
{
|
||||
|
||||
/// <summary>
|
||||
/// Gets the expression-language name used to invoke this function.
|
||||
/// </summary>
|
||||
/// <value><c>atan</c>.</value>
|
||||
public string Name
|
||||
{
|
||||
get
|
||||
|
|
@ -11,6 +21,10 @@
|
|||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets the argument signature expected by the <c>atan</c> function.
|
||||
/// </summary>
|
||||
/// <value>A single numeric argument named <c>value</c>.</value>
|
||||
public override IEnumerable<FunctionArgument> ExpectedArguments
|
||||
{
|
||||
get
|
||||
|
|
@ -19,6 +33,15 @@
|
|||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Executes the <c>atan</c> function.
|
||||
/// </summary>
|
||||
/// <param name="args">
|
||||
/// The evaluated arguments supplied to the function. Exactly one numeric argument is expected.
|
||||
/// </param>
|
||||
/// <returns>
|
||||
/// A numeric <see cref="FunctionValue"/> containing the arctangent of the input value.
|
||||
/// </returns>
|
||||
public FunctionValue Execute(params FunctionArgument[] args)
|
||||
{
|
||||
return Execute(args, (_args) =>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue