Skip to content

Commit fbb32df

Browse files
calacayircalacayir
committed
Use docfx-plus (our new project for improving docfx) for beautiful docs.
1 parent d1ac537 commit fbb32df

5 files changed

Lines changed: 10 additions & 19 deletions

File tree

‎.github/workflows/publish-docs.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ jobs:
3131
with:
3232
dotnet-version: 8.x
3333

34-
- run: dotnet tool update -g docfx
35-
- run: docfx docfx.json
34+
- run: dotnet tool update -g docfx-plus
35+
- run: docfx-plus docfx.json
3636
# use working-directory for docfx step otherwise codeSourceBasePath is not resolved correctly
3737
working-directory: docs
3838

‎build/4. Build Api Docs WebSite.cmd‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
@echo off
22

3-
set projectName=DotMake.CommandLine
43
set srcFolder=..\docs
54
set publishFolder=..\docs\_site
65

7-
dotnet tool update -g docfx
8-
docfx %srcFolder%\docfx.json --serve
6+
dotnet tool update -g docfx-plus
7+
docfx-plus %srcFolder%\docfx.json --serve
98

109
@echo off
1110
if %ERRORLEVEL% EQU 0 (

‎docs/docfx.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
"template": [
5555
"default",
5656
"modern",
57-
//"docfx-plus"
57+
"docfx-plus"
5858
],
5959
//"plugins": [],
6060
"globalMetadata": {

‎src/DotMake.CommandLine.Shared/Attributes/CliCommandAttribute.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,13 +75,13 @@ namespace DotMake.CommandLine
7575
/// <code source="../TestApp/Commands/RootWithNestedChildrenCliCommand.cs" region="RootWithNestedChildrenCliCommand" language="cs" />
7676
/// <code>
7777
/// <code source="../TestApp/Commands/RootWithExternalChildrenCliCommand.cs" region="RootWithExternalChildrenCliCommand" language="cs" />
78-
/// <code source="../TestApp/Commands/External\ExternalLevel1SubCliCommand.cs" region="ExternalLevel1SubCliCommand" language="cs" />
79-
/// <code source="../TestApp/Commands/External\ExternalLevel2SubCliCommand.cs" region="ExternalLevel2SubCliCommand" language="cs" />
78+
/// <code source="../TestApp/Commands/External/ExternalLevel1SubCliCommand.cs" region="ExternalLevel1SubCliCommand" language="cs" />
79+
/// <code source="../TestApp/Commands/External/ExternalLevel2SubCliCommand.cs" region="ExternalLevel2SubCliCommand" language="cs" />
8080
/// </code>
8181
/// <code>
8282
/// <code source="../TestApp/Commands/RootAsExternalParentCliCommand.cs" region="RootAsExternalParentCliCommand" language="cs" />
83-
/// <code source="../TestApp/Commands/External\ExternalLevel1WithParentSubCliCommand.cs" region="ExternalLevel1WithParentSubCliCommand" language="cs" />
84-
/// <code source="../TestApp/Commands/External\ExternalLevel2WithParentSubCliCommand.cs" region="ExternalLevel2WithParentSubCliCommand" language="cs" />
83+
/// <code source="../TestApp/Commands/External/ExternalLevel1WithParentSubCliCommand.cs" region="ExternalLevel1WithParentSubCliCommand" language="cs" />
84+
/// <code source="../TestApp/Commands/External/ExternalLevel2WithParentSubCliCommand.cs" region="ExternalLevel2WithParentSubCliCommand" language="cs" />
8585
/// </code>
8686
/// <code source="../TestApp/Commands/InheritanceCliCommand.cs" region="InheritanceCliCommand" language="cs" />
8787
/// <code source="../TestApp/Commands/LocalizedCliCommand.cs" region="LocalizedCliCommand" language="cs" />

‎src/DotMake.CommandLine/Cli.cs‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
using System;
22
using System.Threading;
33
using System.Threading.Tasks;
4+
#pragma warning disable CS1573 // Parameter has no matching param tag in the XML comment (but other parameters do)
45

56
namespace DotMake.CommandLine
67
{
@@ -51,7 +52,6 @@ public static CliParser GetParser<TDefinition>(CliSettings settings = null)
5152

5253
/// <inheritdoc cref="GetParser{TDefinition}" />
5354
/// <param name="definitionType">The definition class type for the command. A command builder for this class should be automatically generated by the source generator.</param>
54-
/// <param name="settings"><inheritdoc cref="GetParser{TDefinition}" path="/param[@name='settings']/node()" /></param>
5555
public static CliParser GetParser(Type definitionType, CliSettings settings = null)
5656
{
5757
return new CliParser(definitionType, settings);
@@ -66,7 +66,6 @@ public static string[] GetArgs()
6666

6767
/// <inheritdoc cref="CliParser.Parse(string[])" />
6868
/// <typeparam name="TDefinition"><inheritdoc cref="GetParser{TDefinition}" path="/typeparam[@name='TDefinition']/node()" /></typeparam>
69-
/// <param name="args"><inheritdoc cref="CliParser.Parse(string[])" path="/param[@name='args']/node()" /></param>
7069
/// <param name="settings"><inheritdoc cref="GetParser{TDefinition}" path="/param[@name='settings']/node()" /></param>
7170
/// <example>
7271
/// <code source="../TestApp/CliExamples.cs" region="CliParseWithResult" language="cs" />
@@ -80,7 +79,6 @@ public static CliResult Parse<TDefinition>(string[] args = null, CliSettings set
8079

8180
/// <inheritdoc cref="CliParser.Parse(string)" />
8281
/// <typeparam name="TDefinition"><inheritdoc cref="GetParser{TDefinition}" path="/typeparam[@name='TDefinition']/node()" /></typeparam>
83-
/// <param name="commandLine"><inheritdoc cref="CliParser.Parse(string)" path="/param[@name='commandLine']/node()" /></param>
8482
/// <param name="settings"><inheritdoc cref="GetParser{TDefinition}" path="/param[@name='settings']/node()" /></param>
8583
/// <example>
8684
/// <code source="../TestApp/CliExamples.cs" region="CliParseStringWithResult" language="cs" />
@@ -95,7 +93,6 @@ public static CliResult Parse<TDefinition>(string commandLine, CliSettings setti
9593

9694
/// <inheritdoc cref="CliParser.Run(string[])" />
9795
/// <typeparam name="TDefinition"><inheritdoc cref="GetParser{TDefinition}" path="/typeparam[@name='TDefinition']/node()" /></typeparam>
98-
/// <param name="args"><inheritdoc cref="CliParser.Run(string[])" path="/param[@name='args']/node()" /></param>
9996
/// <param name="settings"><inheritdoc cref="GetParser{TDefinition}" path="/param[@name='settings']/node()" /></param>
10097
/// <example>
10198
/// <code source="../TestApp/CliExamples.cs" region="CliRun" language="cs" />
@@ -110,7 +107,6 @@ public static int Run<TDefinition>(string[] args = null, CliSettings settings =
110107

111108
/// <inheritdoc cref="CliParser.Run(string)" />
112109
/// <typeparam name="TDefinition"><inheritdoc cref="GetParser{TDefinition}" path="/typeparam[@name='TDefinition']/node()" /></typeparam>
113-
/// <param name="commandLine"><inheritdoc cref="CliParser.Run(string)" path="/param[@name='commandLine']/node()" /></param>
114110
/// <param name="settings"><inheritdoc cref="GetParser{TDefinition}" path="/param[@name='settings']/node()" /></param>
115111
/// <example>
116112
/// <code source="../TestApp/CliExamples.cs" region="CliRunString" language="cs" />
@@ -125,9 +121,7 @@ public static int Run<TDefinition>(string commandLine, CliSettings settings = nu
125121

126122
/// <inheritdoc cref="CliParser.RunAsync(string[], CancellationToken)" />
127123
/// <typeparam name="TDefinition"><inheritdoc cref="GetParser{TDefinition}" path="/typeparam[@name='TDefinition']/node()" /></typeparam>
128-
/// <param name="args"><inheritdoc cref="CliParser.RunAsync(string[], CancellationToken)" path="/param[@name='args']/node()" /></param>
129124
/// <param name="settings"><inheritdoc cref="GetParser{TDefinition}" path="/param[@name='settings']/node()" /></param>
130-
/// <param name="cancellationToken"><inheritdoc cref="CliParser.RunAsync(string[], CancellationToken)" path="/param[@name='cancellationToken']/node()" /></param>
131125
/// <example>
132126
/// <code source="../TestApp/CliExamples.cs" region="CliRunAsync" language="cs" />
133127
/// <code source="../TestApp/CliExamples.cs" region="CliRunAsyncWithReturn" language="cs" />
@@ -141,9 +135,7 @@ public static async Task<int> RunAsync<TDefinition>(string[] args = null, CliSet
141135

142136
/// <inheritdoc cref="CliParser.RunAsync(string, CancellationToken)" />
143137
/// <typeparam name="TDefinition"><inheritdoc cref="GetParser{TDefinition}" path="/typeparam[@name='TDefinition']/node()" /></typeparam>
144-
/// <param name="commandLine"><inheritdoc cref="CliParser.RunAsync(string, CancellationToken)" path="/param[@name='commandLine']/node()" /></param>
145138
/// <param name="settings"><inheritdoc cref="GetParser{TDefinition}" path="/param[@name='settings']/node()" /></param>
146-
/// <param name="cancellationToken"><inheritdoc cref="CliParser.RunAsync(string, CancellationToken)" path="/param[@name='cancellationToken']/node()" /></param>
147139
/// <example>
148140
/// <code source="../TestApp/CliExamples.cs" region="CliRunAsyncString" language="cs" />
149141
/// <code source="../TestApp/CliExamples.cs" region="CliRunAsyncStringWithReturn" language="cs" />

0 commit comments

Comments
 (0)