Skip to main content

Definition

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

Syntax

CloudNimble.DotNetDocs.Tools.Commands.BuildCommand

Constructors

.ctor

Syntax

public BuildCommand()

.ctor Inherited

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

Syntax

public DocsCommandBase()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

ApiReferencePath

Syntax

public string ApiReferencePath { get; set; }

Property Value

Type: string

AssemblyListFile

Syntax

public string AssemblyListFile { get; set; }

Property Value

Type: string

DocumentationType

Syntax

public string DocumentationType { get; set; }

Property Value

Type: string

NamespaceMode

Syntax

public string NamespaceMode { get; set; }

Property Value

Type: string

OutputPath

Syntax

public string OutputPath { get; set; }

Property Value

Type: string

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

NameTypeDescription
objobject?-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

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

NameTypeDescription
includePrereleaseboolWhether 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

Syntax

public System.Threading.Tasks.Task<int> OnExecute(McMaster.Extensions.CommandLineUtils.CommandLineApplication app)

Parameters

NameTypeDescription
appMcMaster.Extensions.CommandLineUtils.CommandLineApplication-

Returns

Type: System.Threading.Tasks.Task<int>

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

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.