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.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()

​
Methods

​
OnExecute

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

​
Syntax

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

​
Parameters

NameTypeDescription
appMcMaster.Extensions.CommandLineUtils.CommandLineApplicationThe command-line application for which to display help information. Cannot be null.

​
Returns

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