Skip to content

Commit 5ec6c4a

Browse files
KathleenDollardjonsequitur
authored andcommitted
Add xml comments (#741)
1 parent f741e09 commit 5ec6c4a

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

src/System.CommandLine/RootCommand.cs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,22 @@
77

88
namespace System.CommandLine
99
{
10+
/// <summary>
11+
/// A command representing an application entry point.
12+
/// </summary>
1013
public class RootCommand : Command
1114
{
15+
/// <summary>
16+
/// Create a new instance of RootCommand
17+
/// </summary>
18+
/// <param name="description">The description of the command shown in help.</param>
1219
public RootCommand(string description = "") : base(ExecutableName, description)
1320
{
1421
}
1522

23+
/// <summary>
24+
/// The name of the command. Defaults to the executable name.
25+
/// </summary>
1626
public override string Name
1727
{
1828
get => base.Name;
@@ -42,8 +52,14 @@ private static Assembly GetAssembly() =>
4252
Assembly.GetEntryAssembly() ??
4353
Assembly.GetExecutingAssembly();
4454

55+
/// <summary>
56+
/// The name of the currently running executable.
57+
/// </summary>
4558
public static string ExecutableName => _executableName.Value;
4659

60+
/// <summary>
61+
/// The path to the currently running executable.
62+
/// </summary>
4763
public static string ExecutablePath => _executablePath.Value;
4864
}
4965
}

0 commit comments

Comments
 (0)