CommandLineBuilder.xml

<Type Name="CommandLineBuilder" FullName="System.CommandLine.Builder.CommandLineBuilder">
  <TypeSignature Language="C#" Value="public class CommandLineBuilder" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CommandLineBuilder extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.CommandLine.Builder.CommandLineBuilder" />
  <TypeSignature Language="VB.NET" Value="Public Class CommandLineBuilder" />
  <TypeSignature Language="F#" Value="type CommandLineBuilder = class" />
  <TypeSignature Language="C++ CLI" Value="public ref class CommandLineBuilder" />
  <AssemblyInfo>
    <AssemblyName>System.CommandLine</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Enables composition of command line configurations.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public CommandLineBuilder (System.CommandLine.Command? rootCommand = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.CommandLine.Command rootCommand) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.CommandLine.Builder.CommandLineBuilder.#ctor(System.CommandLine.Command)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (Optional rootCommand As Command = Nothing)" />
      <MemberSignature Language="F#" Value="new System.CommandLine.Builder.CommandLineBuilder : System.CommandLine.Command -&gt; System.CommandLine.Builder.CommandLineBuilder" Usage="new System.CommandLine.Builder.CommandLineBuilder rootCommand" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.CommandLine</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="rootCommand" Type="System.CommandLine.Command" />
      </Parameters>
      <Docs>
        <param name="rootCommand">The root command of the application.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Build">
      <MemberSignature Language="C#" Value="public System.CommandLine.Parsing.Parser Build ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.CommandLine.Parsing.Parser Build() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.CommandLine.Builder.CommandLineBuilder.Build" />
      <MemberSignature Language="VB.NET" Value="Public Function Build () As Parser" />
      <MemberSignature Language="F#" Value="member this.Build : unit -&gt; System.CommandLine.Parsing.Parser" Usage="commandLineBuilder.Build " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; System::CommandLine::Parsing::Parser ^ Build();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.CommandLine</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.CommandLine.Parsing.Parser</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Creates a parser based on the configuration of the command line builder.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Command">
      <MemberSignature Language="C#" Value="public System.CommandLine.Command Command { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.CommandLine.Command Command" />
      <MemberSignature Language="DocId" Value="P:System.CommandLine.Builder.CommandLineBuilder.Command" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Command As Command" />
      <MemberSignature Language="F#" Value="member this.Command : System.CommandLine.Command" Usage="System.CommandLine.Builder.CommandLineBuilder.Command" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::CommandLine::Command ^ Command { System::CommandLine::Command ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.CommandLine</AssemblyName>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.CommandLine.Command</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The command that the builder uses the root of the parser.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>