DocsRootCommand - DotNetDocs

Definition

Assembly: CloudNimble.DotNetDocs.Tools.dll Namespace: CloudNimble.DotNetDocs.Tools.Commands Inheritance: CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase

Syntax

CloudNimble.DotNetDocs.Tools.Commands.DocsRootCommand

Summary

Represents the root command for the DotNetDocs command-line interface (CLI) application.

Remarks

This command serves as the entry point for the DotNetDocs CLI and provides access to subcommands such as build and add. When invoked without a subcommand or with insufficient arguments, it displays help information describing available commands and usage.

Constructors

.ctor

Syntax

public DocsRootCommand()

.ctor Inherited

Inherited from CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase

Syntax

public DocsCommandBase()

.ctor Inherited

Inherited from object

Syntax

public Object()

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetLatestSdkVersionAsync Inherited

Inherited from CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase

Queries NuGet.org for the latest version of the DotNetDocs.Sdk package.

Syntax

protected static System.Threading.Tasks.Task<string> GetLatestSdkVersionAsync(bool includePrerelease)

Parameters

Name	Type	Description
`includePrerelease`	`bool`	Whether to include prerelease versions in the search.

Returns

Type: System.Threading.Tasks.Task<string?> The latest version string, or null if the query fails.

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

GetVersion Inherited

Inherited from CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase

Gets the version string for the tool.

Syntax

internal static string GetVersion()

Returns

Type: string The version string.

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

OnExecute

Displays the help information for the specified command-line application.

Syntax

public int OnExecute(McMaster.Extensions.CommandLineUtils.CommandLineApplication app)

Parameters

Name	Type	Description
`app`	`McMaster.Extensions.CommandLineUtils.CommandLineApplication`	The command-line application for which to display help information. Cannot be null.

Returns

Type: int Always returns 0 after displaying the help information.

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

WriteHeader Inherited

Inherited from CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase

Writes the DotNetDocs CLI header to the console with colorful ASCII art and version information.

Syntax

public static void WriteHeader()

Remarks

This method displays a multi-line ASCII art logo combining the DotNetDocs branding with version and attribution information. The output uses console colors to create an eye-catching header for CLI operations.

​Definition

​Syntax

​Summary

​Remarks

​Constructors

​ .ctor

​Syntax

​ .ctor Inherited

​Syntax

​ .ctor Inherited

​Syntax

​Methods

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetLatestSdkVersionAsync Inherited

​Syntax

​Parameters

​Returns

​ GetType Inherited

​Syntax

​Returns

​ GetVersion Inherited

​Syntax

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ OnExecute

​Syntax

​Parameters

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

​ WriteHeader Inherited

​Syntax

​Remarks

Definition

Syntax

Summary

Remarks

Constructors

.ctor

Syntax

.ctor Inherited

Syntax

.ctor Inherited

Syntax

Methods

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetLatestSdkVersionAsync Inherited

Syntax

Parameters

Returns

GetType Inherited

Syntax

Returns

GetVersion Inherited

Syntax

Returns

MemberwiseClone Inherited

Syntax

Returns

OnExecute

Syntax

Parameters

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

ToString Inherited Virtual

Syntax

Returns

WriteHeader Inherited

Syntax

Remarks