Skip to content

Commit 7a6d9b1

Browse files
add docs to Argument.cs
1 parent fcec750 commit 7a6d9b1

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

ArgumentSystem/BaseArguments/Argument.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,24 @@ public abstract class Argument(string name)
66
{
77
public string Name { get; } = name;
88

9+
/// <summary>
10+
/// Allows for this argument to get an unlimited amount of values of this type
11+
/// Every value after this argument also counts towards this one.
12+
/// This argument must be the last argument of the method,
13+
/// </summary>
914
public bool ConsumesRemainingValues { get; init; } = false;
1015

16+
/// <summary>
17+
/// The short description of the argument. Use IAdditionalDescription to add more if needed.
18+
/// </summary>
1119
public string? Description { get; init; } = null;
1220

1321
public bool IsOptional { get; private set; } = false;
1422

23+
/// <summary>
24+
/// Sets the default value for this argument, allowing it to be skipped by the user.
25+
/// Null values are allowed, the method must handle it accordingly.
26+
/// </summary>
1527
public object? DefaultValue
1628
{
1729
get;

0 commit comments

Comments
 (0)