Definition
Assembly: CloudNimble.DotNetDocs.Tools.dll Namespace: CloudNimble.DotNetDocs.Tools.Commands Inheritance: CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBaseSyntax
Summary
Command-line tool for updating existing .docsproj files to use the latest DotNetDocs.Sdk version from NuGet.Remarks
This command searches for all .docsproj files in the current directory (and optionally subdirectories), queries NuGet.org for the latest SDK version, and updates the SDK reference in each file.Constructors
.ctor
Syntax
.ctor Inherited
Inherited from
CloudNimble.DotNetDocs.Tools.Commands.Base.DocsCommandBaseSyntax
.ctor Inherited
Inherited from
objectSyntax
Properties
ProjectPath
Gets or sets the project name or path to a specific .docsproj file to update.Syntax
Property Value
Type:string?
Recursive
Gets or sets whether to search recursively in subdirectories.Syntax
Property Value
Type:bool
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 update .docsproj SDK references to the latest version from NuGet.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 update is
successful; otherwise, 1.
Remarks
If a specific project is not specified, the method searches for all .docsproj files in the current directory (and subdirectories if —recursive is specified). The —project option accepts either a project name (e.g., “MyProject.Docs”) or a file path (e.g., “MyProject.Docs.docsproj” or “path/to/MyProject.Docs.docsproj”). 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