Skip to content
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

Port missing API documentation for System.CommandLine #9228

Closed
wants to merge 6 commits into from
Closed

Port missing API documentation for System.CommandLine #9228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4cfc728
System.CommandLine.Binding
carlossanlop Aug 29, 2023
c1f413a
System.CommandLine.Help
carlossanlop Aug 29, 2023
0211df2
System.CommandLine.Completions
carlossanlop Aug 29, 2023
d343408
System.CommandLine.Parsing
carlossanlop Aug 29, 2023
5d20f5d
System.CommandLine
carlossanlop Aug 29, 2023
d62fdca
Update ArgumentResult.xml
gewarren Aug 29, 2023
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
330 changes: 165 additions & 165 deletions xml/System.CommandLine.Binding/BindingContext.xml
View file
Open in desktop

Large diffs are not rendered by default.

298 changes: 149 additions & 149 deletions xml/System.CommandLine.Binding/BoundValue.xml
View file
Open in desktop

Large diffs are not rendered by default.

582 changes: 291 additions & 291 deletions xml/System.CommandLine.Completions/CompletionItem.xml
View file
Open in desktop

Large diffs are not rendered by default.

352 changes: 176 additions & 176 deletions xml/System.CommandLine.Help/TwoColumnHelpRow.xml
View file
Open in desktop

Large diffs are not rendered by default.

296 changes: 148 additions & 148 deletions xml/System.CommandLine.Parsing/ArgumentResult.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,148 +1,148 @@
<Type Name="ArgumentResult" FullName="System.CommandLine.Parsing.ArgumentResult">
<TypeSignature Language="C#" Value="public class ArgumentResult : System.CommandLine.Parsing.SymbolResult" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ArgumentResult extends System.CommandLine.Parsing.SymbolResult" />
<TypeSignature Language="DocId" Value="T:System.CommandLine.Parsing.ArgumentResult" />
<TypeSignature Language="VB.NET" Value="Public Class ArgumentResult&#xA;Inherits SymbolResult" />
<TypeSignature Language="F#" Value="type ArgumentResult = class&#xA; inherit SymbolResult" />
<TypeSignature Language="C++ CLI" Value="public ref class ArgumentResult : System::CommandLine::Parsing::SymbolResult" />
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.CommandLine.Parsing.SymbolResult</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A result produced when parsing an <see cref="P:System.CommandLine.Parsing.ArgumentResult.Argument" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Argument">
<MemberSignature Language="C#" Value="public System.CommandLine.Argument Argument { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.CommandLine.Argument Argument" />
<MemberSignature Language="DocId" Value="P:System.CommandLine.Parsing.ArgumentResult.Argument" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Argument As Argument" />
<MemberSignature Language="F#" Value="member this.Argument : System.CommandLine.Argument" Usage="System.CommandLine.Parsing.ArgumentResult.Argument" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::CommandLine::Argument ^ Argument { System::CommandLine::Argument ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.CommandLine.Argument</ReturnType>
</ReturnValue>
<Docs>
<summary>
The argument to which the result applies.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetValueOrDefault">
<MemberSignature Language="C#" Value="public object? GetValueOrDefault ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance object GetValueOrDefault() cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.Parsing.ArgumentResult.GetValueOrDefault" />
<MemberSignature Language="VB.NET" Value="Public Function GetValueOrDefault () As Object" />
<MemberSignature Language="F#" Value="member this.GetValueOrDefault : unit -&gt; obj" Usage="argumentResult.GetValueOrDefault " />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::Object ^ GetValueOrDefault();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.CommandLine.Parsing.ArgumentResult.GetValueOrDefault``1" />
</Docs>
</Member>
<Member MemberName="GetValueOrDefault&lt;T&gt;">
<MemberSignature Language="C#" Value="public T GetValueOrDefault&lt;T&gt; ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance !!T GetValueOrDefault&lt;T&gt;() cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.Parsing.ArgumentResult.GetValueOrDefault``1" />
<MemberSignature Language="VB.NET" Value="Public Function GetValueOrDefault(Of T) () As T" />
<MemberSignature Language="F#" Value="member this.GetValueOrDefault : unit -&gt; 'T" Usage="argumentResult.GetValueOrDefault " />
<MemberSignature Language="C++ CLI" Value="public:&#xA;generic &lt;typename T&gt;&#xA; T GetValueOrDefault();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters />
<Docs>
<typeparam name="T">To be added.</typeparam>
<summary>
Gets the parsed value or the default value for <see cref="P:System.CommandLine.Parsing.ArgumentResult.Argument" />.
</summary>
<returns>The parsed value or the default value for <see cref="P:System.CommandLine.Parsing.ArgumentResult.Argument" /></returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnlyTake">
<MemberSignature Language="C#" Value="public void OnlyTake (int numberOfTokens);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void OnlyTake(int32 numberOfTokens) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.Parsing.ArgumentResult.OnlyTake(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub OnlyTake (numberOfTokens As Integer)" />
<MemberSignature Language="F#" Value="member this.OnlyTake : int -&gt; unit" Usage="argumentResult.OnlyTake numberOfTokens" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; void OnlyTake(int numberOfTokens);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="numberOfTokens" Type="System.Int32" />
</Parameters>
<Docs>
<param name="numberOfTokens">The number of tokens to take. The rest are passed on.</param>
<summary>
Specifies the maximum number of tokens to consume for the argument. Remaining tokens are passed on and can be consumed by later arguments, or will otherwise be added to <see cref="P:System.CommandLine.Parsing.ParseResult.UnmatchedTokens" /></summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">numberOfTokens - Value must be at least 1.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if this method is called more than once.</exception>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.Parsing.ArgumentResult.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="argumentResult.ToString " />
<MemberSignature Language="C++ CLI" Value="public:&#xA; override System::String ^ ToString();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
</Type>
<Type Name="ArgumentResult" FullName="System.CommandLine.Parsing.ArgumentResult">
<TypeSignature Language="C#" Value="public class ArgumentResult : System.CommandLine.Parsing.SymbolResult" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ArgumentResult extends System.CommandLine.Parsing.SymbolResult" />
<TypeSignature Language="DocId" Value="T:System.CommandLine.Parsing.ArgumentResult" />
<TypeSignature Language="VB.NET" Value="Public Class ArgumentResult&#xA;Inherits SymbolResult" />
<TypeSignature Language="F#" Value="type ArgumentResult = class&#xA; inherit SymbolResult" />
<TypeSignature Language="C++ CLI" Value="public ref class ArgumentResult : System::CommandLine::Parsing::SymbolResult" />
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.CommandLine.Parsing.SymbolResult</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents the result produced when parsing an <see cref="P:System.CommandLine.Parsing.ArgumentResult.Argument" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Argument">
<MemberSignature Language="C#" Value="public System.CommandLine.Argument Argument { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.CommandLine.Argument Argument" />
<MemberSignature Language="DocId" Value="P:System.CommandLine.Parsing.ArgumentResult.Argument" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Argument As Argument" />
<MemberSignature Language="F#" Value="member this.Argument : System.CommandLine.Argument" Usage="System.CommandLine.Parsing.ArgumentResult.Argument" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::CommandLine::Argument ^ Argument { System::CommandLine::Argument ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.CommandLine.Argument</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the argument to which the result applies.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetValueOrDefault">
<MemberSignature Language="C#" Value="public object? GetValueOrDefault ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance object GetValueOrDefault() cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.Parsing.ArgumentResult.GetValueOrDefault" />
<MemberSignature Language="VB.NET" Value="Public Function GetValueOrDefault () As Object" />
<MemberSignature Language="F#" Value="member this.GetValueOrDefault : unit -&gt; obj" Usage="argumentResult.GetValueOrDefault " />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::Object ^ GetValueOrDefault();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.CommandLine.Parsing.ArgumentResult.GetValueOrDefault``1" />
</Docs>
</Member>
<Member MemberName="GetValueOrDefault&lt;T&gt;">
<MemberSignature Language="C#" Value="public T GetValueOrDefault&lt;T&gt; ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance !!T GetValueOrDefault&lt;T&gt;() cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.Parsing.ArgumentResult.GetValueOrDefault``1" />
<MemberSignature Language="VB.NET" Value="Public Function GetValueOrDefault(Of T) () As T" />
<MemberSignature Language="F#" Value="member this.GetValueOrDefault : unit -&gt; 'T" Usage="argumentResult.GetValueOrDefault " />
<MemberSignature Language="C++ CLI" Value="public:&#xA;generic &lt;typename T&gt;&#xA; T GetValueOrDefault();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters />
<Docs>
<typeparam name="T">To be added.</typeparam>
<summary>
Gets the parsed value or the default value for <see cref="P:System.CommandLine.Parsing.ArgumentResult.Argument" />.
</summary>
<returns>The parsed value or the default value for <see cref="P:System.CommandLine.Parsing.ArgumentResult.Argument" /></returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnlyTake">
<MemberSignature Language="C#" Value="public void OnlyTake (int numberOfTokens);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void OnlyTake(int32 numberOfTokens) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.Parsing.ArgumentResult.OnlyTake(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub OnlyTake (numberOfTokens As Integer)" />
<MemberSignature Language="F#" Value="member this.OnlyTake : int -&gt; unit" Usage="argumentResult.OnlyTake numberOfTokens" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; void OnlyTake(int numberOfTokens);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="numberOfTokens" Type="System.Int32" />
</Parameters>
<Docs>
<param name="numberOfTokens">The number of tokens to take. The rest are passed on.</param>
<summary>
Specifies the maximum number of tokens to consume for the argument. Remaining tokens are passed on and can be consumed by later arguments, or will otherwise be added to <see cref="P:System.CommandLine.Parsing.ParseResult.UnmatchedTokens" />.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="numberOfTokens" /> is less than 1.</exception>
<exception cref="T:System.InvalidOperationException">This method was called more than once.</exception>
<exception cref="T:System.NotSupportedException">This method was called by Option-owned ArgumentResult.</exception>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:System.CommandLine.Parsing.ArgumentResult.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="argumentResult.ToString " />
<MemberSignature Language="C++ CLI" Value="public:&#xA; override System::String ^ ToString();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.CommandLine</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
</Type>
Loading