Skip to content

XML documentation for Argument<T> class #1100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 11, 2020
Merged

XML documentation for Argument<T> class #1100

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7334a4d
Merge remote-tracking branch 'upstream/main' into main
pieter-venter Nov 25, 2020
958b2cb
Add XML documentation to the Argument{T} class
pieter-venter Nov 27, 2020
6e977d4
Add suggested changes.
pieter-venter Dec 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions src/System.CommandLine/Argument{T}.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,22 @@

namespace System.CommandLine
{
///<inheritdoc/>
public class Argument<T> : Argument
{
/// <summary>
/// Initializes a new instance of the Argument class.
/// </summary>
public Argument()
{
ArgumentType = typeof(T);
}

/// <summary>
/// Initializes a new instance of the Argument class.
/// </summary>
/// <param name="name">The name of the argument.</param>
/// <param name="description">The description of the argument, shown in help.</param>
public Argument(
string name,
string? description = null) : base(name)
Expand All @@ -20,6 +29,13 @@ public Argument(
Description = description;
}

/// <summary>
/// Initializes a new instance of the Argument class.
/// </summary>
/// <param name="name">The name of the argument.</param>
/// <param name="getDefaultValue">The delegate to invoke to return the default value.</param>
/// <param name="description">The description of the argument, shown in help.</param>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="getDefaultValue"/> is null.</exception>
public Argument(
string name,
Func<T> getDefaultValue,
Expand All @@ -35,6 +51,11 @@ public Argument(
Description = description;
}

/// <summary>
/// Initializes a new instance of the Argument class.
/// </summary>
/// <param name="getDefaultValue">The delegate to invoke to return the default value.</param>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="getDefaultValue"/> is null.</exception>
public Argument(Func<T> getDefaultValue) : this()
{
if (getDefaultValue is null)
Expand All @@ -45,6 +66,13 @@ public Argument(Func<T> getDefaultValue) : this()
SetDefaultValueFactory(() => getDefaultValue());
}

/// <summary>
/// Initializes a new instance of the Argument class.
/// </summary>
/// <param name="name">The name of the argument.</param>
/// <param name="parse">A custom argument parser.</param>
/// <param name="isDefault"><c>true</c> to use the <paramref name="parse"/> result as default value.</param>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="parse"/> is null.</exception>
public Argument(
string? name,
ParseArgument<T> parse,
Expand Down Expand Up @@ -82,6 +110,11 @@ public Argument(
};
}

/// <summary>
/// Initializes a new instance of the Argument class.
/// </summary>
/// <param name="parse">A custom argument parser.</param>
/// <param name="isDefault"><c>true</c> to use the <paramref name="parse"/> result as default value.</param>
public Argument(ParseArgument<T> parse, bool isDefault = false) : this(null, parse, isDefault)
{
}
Expand Down