Definition
Assembly: CloudNimble.DotNetDocs.Tools.dll Namespace: CloudNimble.DotNetDocs.Tools.Commands Inheritance: CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBaseSyntax
Summary
Command-line tool for creating and adding a documentation project to a solution file.Remarks
This command creates a .docsproj file configured for the specified documentation type (defaults to Mintlify) and adds it to the specified solution file (.sln or .slnx). The project is automatically added to a “Docs” solution folder. For .slnx files, the command post-processes the XML to add Type=“C#” attributes to .docsproj nodes.Constructors
.ctor
Syntax
.ctor Inherited
Inherited from
CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBaseSyntax
.ctor Inherited
Inherited from
objectSyntax
Properties
DocumentationType
Gets or sets the documentation type for the project.Syntax
Property Value
Type:string?
OutputDirectory
Gets or sets the output directory for the generated documentation project.Syntax
Property Value
Type:string?
ProjectName
Gets or sets the name of the documentation project.Syntax
Property Value
Type:string?
Remarks
If not specified, the project name defaults to the solution name.SkipSolution
Gets or sets whether to skip adding the project to the solution file.Syntax
Property Value
Type:bool
SolutionPath
Gets or sets the path to the solution file (.sln or .slnx) to use.Syntax
Property Value
Type:string?
UsePrerelease
Gets or sets whether to use the latest prerelease version of the DotNetDocs.Sdk.Syntax
Property Value
Type:bool
Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
obj | object? | - |
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetLatestSdkVersionAsync Inherited
Inherited from
CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBaseSyntax
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
objectSyntax
Returns
Type:System.Type
GetVersion Inherited
Inherited from
CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBaseSyntax
Returns
Type:string
The version string.
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
OnExecute
Executes the command to create and add a documentation project to the specified solution.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
app | McMaster.Extensions.CommandLineUtils.CommandLineApplication | The command-line application context used to access command-line arguments and configuration. |
Returns
Type:System.Threading.Tasks.Task<int>
A task that represents the asynchronous operation. The task result is 0 if the documentation project is
created and added successfully; otherwise, 1.
Remarks
If the solution file is not specified, the method attempts to locate one in the current directory. The documentation project is created in the specified output directory or, if not provided, in a default location based on the solution file. Any errors encountered during execution are reported to the console, and a nonzero exit code is returned.ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?
WriteHeader Inherited
Inherited from
CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBase