docs: update documentation for 2.5 (#325)

[ci skip]

Author: natemcmaster

docs/api/index.md

@@ -4,7 +4,7 @@ uid: latest_api_ref
 API Reference
 =============
 
-**Version 2.4**
+**Version 2.5**
 
 McMaster.Extensions.CommandLineUtils supports three target frameworks.
 

docs/docfx.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "https://dotnet.github.io/docfx/schemas/v1.0/schema.json",
   "metadata": [
     {
       "src": [
@@ -23,7 +24,8 @@
   "build": {
     "content": [
       { "version": "unstable", "files": ["**/*.yml", "**/*.md"], "src": "obj/unstable", "dest": "unstable" },
-      { "version": "v2.4", "files": ["**/*.yml", "**/*.md"], "exclude": [ "v2.2/", "v2.3/", "obj/", "**.meta", "README.md", "filterConfig.yml" ] },
+      { "version": "v2.5", "files": ["**/*.yml", "**/*.md"], "exclude": [ "v2.2/", "v2.3/", "v2.4/", "obj/", "**.meta", "README.md", "filterConfig.yml" ] },
+      { "version": "v2.4", "files": ["**/*.yml", "**/*.md"], "src": "v2.4", "dest": "v2.4" },
       { "version": "v2.3", "files": ["**/*.yml", "**/*.md"], "src": "v2.3", "dest": "v2.3" },
       { "version": "v2.2", "files": ["**/*.yml", "**/*.md"], "src": "v2.2", "dest": "v2.2" }
     ],

docs/docs/advanced/generic-host.md

@@ -23,17 +23,17 @@ as well as command line parsing options with this library.
 
 Generic host integration allows you to use the most current DI configuration approach indicated by the aspnet project.  The basic approach starts by creating the builder:
 
-[!code-csharp[](../../samples/dependency-injection/generic-host/Program.cs?name=Program&range=26-26)]
+[!code-csharp[Program](../../samples/dependency-injection/generic-host/Program.cs?range=26-26)]
 
 Then you can configure your features:
 
-[!code-csharp[](../../samples/dependency-injection/generic-host/Program.cs?name=Program&range=27-34)]
+[!code-csharp[Program](../../samples/dependency-injection/generic-host/Program.cs?range=27-34)]
 
 And finally, run your program:
 
-[!code-csharp[](../../samples/dependency-injection/generic-host/Program.cs?name=Program&range=35-35)]
+[!code-csharp[Program](../../samples/dependency-injection/generic-host/Program.cs?range=35-35)]
 
 Below is the full source code for the generic host services example. Notice that instance of `IGreeter` will be injected into the `Program` constructor thanks to the dependency injection.
 
-[!code-csharp[](../../samples/dependency-injection/custom/Program.cs?name=Program&highlight=32-32)]
+[!code-csharp[Program](../../samples/dependency-injection/custom/Program.cs?highlight=32)]
 

docs/filterConfig.yml

@@ -1,10 +1,10 @@
 apiRules:
 - exclude:
-  uidRegex: ^System\.Object
-  type: Type
+    uidRegex: ^System\.Object
+    type: Type
 - exclude:
-  uidRegex: ^System\.Attribute
-  type: Type
+    uidRegex: ^System\.Attribute
+    type: Type
 - exclude:
-  uidRegex: ^System\.ComponentModel\.DataAnnotations\.ValidationAttribute
-  type: Type
+    uidRegex: ^System\.ComponentModel\.DataAnnotations\.ValidationAttribute
+    type: Type

docs/generate.ps1

@@ -24,7 +24,7 @@ try {
         exec git worktree add $targetDir gh-pages 2>&1 | out-null
     }
 
-    $docfxVersion = '2.45.0'
+    $docfxVersion = '2.48.0'
     $docfxRoot = "$buildRoot/packages/docfx.console/$docfxVersion"
     $docfx = "$docfxRoot/tools/docfx.exe"
     if (-not (Test-Path $docfx)) {

docs/toc.yml

@@ -3,13 +3,13 @@
 - name: Documentation
   href: docs/
 - name: API Reference
-  href: api/index.md
+  href: api/
   dropdown: true
   items:
-  - name: Latest
-    href: api/index.md
+  - name: Latest (v2.5)
+    href: api/
   - name: v2.4
-    href: v2.4/api/
+    topicHref: /CommandLineUtils/v2.4/api/index.html
   - name: v2.3
     topicHref: /CommandLineUtils/v2.3/api/index.html
   - name: v2.2

docs/v2.4/api/index.md

@@ -0,0 +1,32 @@
+---
+uid: latest_api_ref
+---
+API Reference
+=============
+
+**Version 2.4**
+
+McMaster.Extensions.CommandLineUtils supports three target frameworks.
+
+ - .NET Standard 2.0
+ - .NET Standard 1.6
+ - .NET Framework 4.5
+
+The API is almost identical between all of the frameworks.
+
+The main entry point for most command line applications is [CommandLineApplication](xref:McMaster.Extensions.CommandLineUtils.CommandLineApplication).
+
+For apps built using attributes, these are the most common attributes used:
+
+ - [OptionAttribute](xref:McMaster.Extensions.CommandLineUtils.OptionAttribute)
+ - [ArgumentAttribute](xref:McMaster.Extensions.CommandLineUtils.ArgumentAttribute)
+ - [CommandAttribute](xref:McMaster.Extensions.CommandLineUtils.CommandAttribute)
+ - [SubcommandAttribute](xref:McMaster.Extensions.CommandLineUtils.SubcommandAttribute)
+ - [HelpOptionAttribute](xref:McMaster.Extensions.CommandLineUtils.HelpOptionAttribute)
+
+Other commonly used types include
+
+ - [DotNetExe](xref:McMaster.Extensions.CommandLineUtils.DotNetExe)
+ - [Prompt](xref:McMaster.Extensions.CommandLineUtils.Prompt)
+ - [ArgumentEscaper](xref:McMaster.Extensions.CommandLineUtils.ArgumentEscaper)
+ - [IConsole](xref:McMaster.Extensions.CommandLineUtils.IConsole)

docs/v2.4/toc.yml

@@ -0,0 +1,2 @@
+- name: API Reference
+  href: api/index.md