Skip to content

Commit 8776f6e

Browse files
Add XML documentation to the ISymbol interface (#1105)
1 parent 47e3617 commit 8776f6e

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

src/System.CommandLine/ISymbol.cs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,34 @@
66

77
namespace System.CommandLine
88
{
9+
/// <summary>
10+
/// Defines a named symbol that resides in a hierarchy with parent and child symbols.
11+
/// </summary>
912
public interface ISymbol : ISuggestionSource
1013
{
14+
/// <summary>
15+
/// Gets the symbol name.
16+
/// </summary>
1117
string Name { get; }
1218

19+
/// <summary>
20+
/// Gets the symbol description.
21+
/// </summary>
1322
string? Description { get; }
1423

24+
/// <summary>
25+
/// Gets a value that indicates whether the symbol is hidden.
26+
/// </summary>
1527
bool IsHidden { get; }
1628

29+
/// <summary>
30+
/// Gets the child symbols.
31+
/// </summary>
1732
ISymbolSet Children { get; }
1833

34+
/// <summary>
35+
/// Gets the parent symbols.
36+
/// </summary>
1937
ISymbolSet Parents { get; }
2038
}
2139
}

0 commit comments

Comments
 (0)