Skip to content

Commit 9594670

Browse files
natemcmasternatemcmaster
committed
Regenerate documentation
1 parent 4d5eb6c commit 9594670

19 files changed

+1606
-322
lines changed

‎CHANGELOG.md‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
# Changelog
22

3+
## Unreleased
4+
5+
- Added support for command validators using `CommandLineApplication.Validators` and added a new OnValidate convention
6+
- Fix minor bug in ArgumentEscaper where some strings were not properly escaped
7+
38
## [v2.2.0-rc]
49

510
**March 23, 2018**
611

712
New API:
8-
- [@atruskie]: Add support for user-defined value parsers using `IValueParser` and `CommandLineApplication.ValueParsers`.
9-
- Add support for `Option<T>` and `Argument<T>`
10-
- Add `IValidationBuilder<T>`
11-
- Add `.Accepts().Range(min, max)` for int and double type arguments and options
13+
- [@atruskie]: Added support for user-defined value parsers using `IValueParser` and `CommandLineApplication.ValueParsers`.
14+
- Added support for `Option<T>` and `Argument<T>`
15+
- Added `IValidationBuilder<T>`
16+
- Added `.Accepts().Range(min, max)` for int and double type arguments and options
1217

1318
Enhancements:
1419
- Parse these values to boolean: T, t, F, f, 0, 1

‎docs/api/McMaster.Extensions.CommandLineUtils.CommandArgument-1.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,9 @@ <h3 id="extensionmethods">Extension Methods</h3>
274274
<div>
275275
<a class="xref" href="McMaster.Extensions.CommandLineUtils.ValidationExtensions.html#McMaster_Extensions_CommandLineUtils_ValidationExtensions_Accepts__1_McMaster_Extensions_CommandLineUtils_CommandArgument___0__">ValidationExtensions.Accepts&lt;T&gt;(CommandArgument&lt;T&gt;)</a>
276276
</div>
277+
<div>
278+
<a class="xref" href="McMaster.Extensions.CommandLineUtils.ValidationExtensions.html#McMaster_Extensions_CommandLineUtils_ValidationExtensions_OnValidate_McMaster_Extensions_CommandLineUtils_CommandArgument_System_Func_System_ComponentModel_DataAnnotations_ValidationContext_System_ComponentModel_DataAnnotations_ValidationResult__">ValidationExtensions.OnValidate(CommandArgument, Func&lt;ValidationContext, ValidationResult&gt;)</a>
279+
</div>
277280
</article>
278281
</div>
279282

‎docs/api/McMaster.Extensions.CommandLineUtils.CommandArgument.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -369,6 +369,9 @@ <h3 id="extensionmethods">Extension Methods</h3>
369369
<div>
370370
<a class="xref" href="McMaster.Extensions.CommandLineUtils.ValidationExtensions.html#McMaster_Extensions_CommandLineUtils_ValidationExtensions_Accepts_McMaster_Extensions_CommandLineUtils_CommandArgument_">ValidationExtensions.Accepts(CommandArgument)</a>
371371
</div>
372+
<div>
373+
<a class="xref" href="McMaster.Extensions.CommandLineUtils.ValidationExtensions.html#McMaster_Extensions_CommandLineUtils_ValidationExtensions_OnValidate_McMaster_Extensions_CommandLineUtils_CommandArgument_System_Func_System_ComponentModel_DataAnnotations_ValidationContext_System_ComponentModel_DataAnnotations_ValidationResult__">ValidationExtensions.OnValidate(CommandArgument, Func&lt;ValidationContext, ValidationResult&gt;)</a>
374+
</div>
372375
</article>
373376
</div>
374377

‎docs/api/McMaster.Extensions.CommandLineUtils.CommandLineApplication-1.html‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,9 @@ <h5>Inherited Members</h5>
284284
<div>
285285
<a class="xref" href="McMaster.Extensions.CommandLineUtils.CommandLineApplication.html#McMaster_Extensions_CommandLineUtils_CommandLineApplication_ValidationErrorHandler">CommandLineApplication.ValidationErrorHandler</a>
286286
</div>
287+
<div>
288+
<a class="xref" href="McMaster.Extensions.CommandLineUtils.CommandLineApplication.html#McMaster_Extensions_CommandLineUtils_CommandLineApplication_Validators">CommandLineApplication.Validators</a>
289+
</div>
287290
<div>
288291
<span class="xref">System.Object.Equals(System.Object)</span>
289292
</div>
@@ -756,6 +759,9 @@ <h3 id="extensionmethods">Extension Methods</h3>
756759
<div>
757760
<a class="xref" href="McMaster.Extensions.CommandLineUtils.CommandLineApplicationExtensions.html#McMaster_Extensions_CommandLineUtils_CommandLineApplicationExtensions_VersionOptionFromAssemblyAttributes_McMaster_Extensions_CommandLineUtils_CommandLineApplication_System_Reflection_Assembly_">CommandLineApplicationExtensions.VersionOptionFromAssemblyAttributes(CommandLineApplication, Assembly)</a>
758761
</div>
762+
<div>
763+
<a class="xref" href="McMaster.Extensions.CommandLineUtils.ValidationExtensions.html#McMaster_Extensions_CommandLineUtils_ValidationExtensions_OnValidate_McMaster_Extensions_CommandLineUtils_CommandLineApplication_System_Func_System_ComponentModel_DataAnnotations_ValidationContext_System_ComponentModel_DataAnnotations_ValidationResult__">ValidationExtensions.OnValidate(CommandLineApplication, Func&lt;ValidationContext, ValidationResult&gt;)</a>
764+
</div>
759765
</article>
760766
</div>
761767

‎docs/api/McMaster.Extensions.CommandLineUtils.CommandLineApplication.html‎

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1054,7 +1054,7 @@ <h5 class="propertyValue">Property Value</h5>
10541054
<a href="https://github.com/natemcmaster/CommandLineUtils/new/master/apiSpec/new?filename=McMaster_Extensions_CommandLineUtils_CommandLineApplication_ValidationErrorHandler.md&amp;value=---%0Auid%3A%20McMaster.Extensions.CommandLineUtils.CommandLineApplication.ValidationErrorHandler%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
10551055
</span>
10561056
<span class="small pull-right mobile-hide">
1057-
<a href="https://github.com/natemcmaster/CommandLineUtils/blob/master/src/CommandLineUtils/CommandLineApplication.Validation.cs/#L17">View Source</a>
1057+
<a href="https://github.com/natemcmaster/CommandLineUtils/blob/master/src/CommandLineUtils/CommandLineApplication.Validation.cs/#L19">View Source</a>
10581058
</span>
10591059
<a id="McMaster_Extensions_CommandLineUtils_CommandLineApplication_ValidationErrorHandler_" data-uid="McMaster.Extensions.CommandLineUtils.CommandLineApplication.ValidationErrorHandler*"></a>
10601060
<h4 id="McMaster_Extensions_CommandLineUtils_CommandLineApplication_ValidationErrorHandler" data-uid="McMaster.Extensions.CommandLineUtils.CommandLineApplication.ValidationErrorHandler">ValidationErrorHandler</h4>
@@ -1081,6 +1081,38 @@ <h5 class="propertyValue">Property Value</h5>
10811081
</tr>
10821082
</tbody>
10831083
</table>
1084+
<span class="small pull-right mobile-hide">
1085+
<span class="divider">|</span>
1086+
<a href="https://github.com/natemcmaster/CommandLineUtils/new/master/apiSpec/new?filename=McMaster_Extensions_CommandLineUtils_CommandLineApplication_Validators.md&amp;value=---%0Auid%3A%20McMaster.Extensions.CommandLineUtils.CommandLineApplication.Validators%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
1087+
</span>
1088+
<span class="small pull-right mobile-hide">
1089+
<a href="https://github.com/natemcmaster/CommandLineUtils/blob/master/src/CommandLineUtils/CommandLineApplication.Validation.cs/#L29">View Source</a>
1090+
</span>
1091+
<a id="McMaster_Extensions_CommandLineUtils_CommandLineApplication_Validators_" data-uid="McMaster.Extensions.CommandLineUtils.CommandLineApplication.Validators*"></a>
1092+
<h4 id="McMaster_Extensions_CommandLineUtils_CommandLineApplication_Validators" data-uid="McMaster.Extensions.CommandLineUtils.CommandLineApplication.Validators">Validators</h4>
1093+
<div class="markdown level1 summary"><p>A collection of validators that execute before invoking <a class="xref" href="McMaster.Extensions.CommandLineUtils.CommandLineApplication.html#McMaster_Extensions_CommandLineUtils_CommandLineApplication_OnExecute_System_Func_System_Int32__">OnExecute(Func&lt;Int32&gt;)</a>.
1094+
When validation fails, <a class="xref" href="McMaster.Extensions.CommandLineUtils.CommandLineApplication.html#McMaster_Extensions_CommandLineUtils_CommandLineApplication_ValidationErrorHandler">ValidationErrorHandler</a> is invoked.</p>
1095+
</div>
1096+
<div class="markdown level1 conceptual"></div>
1097+
<h5 class="decalaration">Declaration</h5>
1098+
<div class="codewrapper">
1099+
<pre><code class="lang-csharp hljs">public ICollection&lt;ICommandValidator&gt; Validators { get; }</code></pre>
1100+
</div>
1101+
<h5 class="propertyValue">Property Value</h5>
1102+
<table class="table table-bordered table-striped table-condensed">
1103+
<thead>
1104+
<tr>
1105+
<th>Type</th>
1106+
<th>Description</th>
1107+
</tr>
1108+
</thead>
1109+
<tbody>
1110+
<tr>
1111+
<td><span class="xref">System.Collections.Generic.ICollection</span>&lt;<a class="xref" href="McMaster.Extensions.CommandLineUtils.Validation.ICommandValidator.html">ICommandValidator</a>&gt;</td>
1112+
<td></td>
1113+
</tr>
1114+
</tbody>
1115+
</table>
10841116
<span class="small pull-right mobile-hide">
10851117
<span class="divider">|</span>
10861118
<a href="https://github.com/natemcmaster/CommandLineUtils/new/master/apiSpec/new?filename=McMaster_Extensions_CommandLineUtils_CommandLineApplication_ValueParsers.md&amp;value=---%0Auid%3A%20McMaster.Extensions.CommandLineUtils.CommandLineApplication.ValueParsers%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
@@ -3151,6 +3183,9 @@ <h3 id="extensionmethods">Extension Methods</h3>
31513183
<div>
31523184
<a class="xref" href="McMaster.Extensions.CommandLineUtils.CommandLineApplicationExtensions.html#McMaster_Extensions_CommandLineUtils_CommandLineApplicationExtensions_VersionOptionFromAssemblyAttributes_McMaster_Extensions_CommandLineUtils_CommandLineApplication_System_Reflection_Assembly_">CommandLineApplicationExtensions.VersionOptionFromAssemblyAttributes(CommandLineApplication, Assembly)</a>
31533185
</div>
3186+
<div>
3187+
<a class="xref" href="McMaster.Extensions.CommandLineUtils.ValidationExtensions.html#McMaster_Extensions_CommandLineUtils_ValidationExtensions_OnValidate_McMaster_Extensions_CommandLineUtils_CommandLineApplication_System_Func_System_ComponentModel_DataAnnotations_ValidationContext_System_ComponentModel_DataAnnotations_ValidationResult__">ValidationExtensions.OnValidate(CommandLineApplication, Func&lt;ValidationContext, ValidationResult&gt;)</a>
3188+
</div>
31543189
</article>
31553190
</div>
31563191

@@ -3162,7 +3197,7 @@ <h3 id="extensionmethods">Extension Methods</h3>
31623197
<a href="https://github.com/natemcmaster/CommandLineUtils/new/master/apiSpec/new?filename=McMaster_Extensions_CommandLineUtils_CommandLineApplication.md&amp;value=---%0Auid%3A%20McMaster.Extensions.CommandLineUtils.CommandLineApplication%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
31633198
</li>
31643199
<li>
3165-
<a href="https://github.com/natemcmaster/CommandLineUtils/blob/master/src/CommandLineUtils/CommandLineApplication.Validation.cs/#L9" class="contribution-link">View Source</a>
3200+
<a href="https://github.com/natemcmaster/CommandLineUtils/blob/master/src/CommandLineUtils/CommandLineApplication.Validation.cs/#L11" class="contribution-link">View Source</a>
31663201
</li>
31673202
</ul>
31683203
</div>

‎docs/api/McMaster.Extensions.CommandLineUtils.CommandOption-1.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,9 @@ <h3 id="extensionmethods">Extension Methods</h3>
307307
<div>
308308
<a class="xref" href="McMaster.Extensions.CommandLineUtils.ValidationExtensions.html#McMaster_Extensions_CommandLineUtils_ValidationExtensions_Accepts__1_McMaster_Extensions_CommandLineUtils_CommandOption___0__">ValidationExtensions.Accepts&lt;T&gt;(CommandOption&lt;T&gt;)</a>
309309
</div>
310+
<div>
311+
<a class="xref" href="McMaster.Extensions.CommandLineUtils.ValidationExtensions.html#McMaster_Extensions_CommandLineUtils_ValidationExtensions_OnValidate_McMaster_Extensions_CommandLineUtils_CommandOption_System_Func_System_ComponentModel_DataAnnotations_ValidationContext_System_ComponentModel_DataAnnotations_ValidationResult__">ValidationExtensions.OnValidate(CommandOption, Func&lt;ValidationContext, ValidationResult&gt;)</a>
312+
</div>
310313
</article>
311314
</div>
312315

‎docs/api/McMaster.Extensions.CommandLineUtils.CommandOption.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -630,6 +630,9 @@ <h3 id="extensionmethods">Extension Methods</h3>
630630
<div>
631631
<a class="xref" href="McMaster.Extensions.CommandLineUtils.ValidationExtensions.html#McMaster_Extensions_CommandLineUtils_ValidationExtensions_Accepts_McMaster_Extensions_CommandLineUtils_CommandOption_">ValidationExtensions.Accepts(CommandOption)</a>
632632
</div>
633+
<div>
634+
<a class="xref" href="McMaster.Extensions.CommandLineUtils.ValidationExtensions.html#McMaster_Extensions_CommandLineUtils_ValidationExtensions_OnValidate_McMaster_Extensions_CommandLineUtils_CommandOption_System_Func_System_ComponentModel_DataAnnotations_ValidationContext_System_ComponentModel_DataAnnotations_ValidationResult__">ValidationExtensions.OnValidate(CommandOption, Func&lt;ValidationContext, ValidationResult&gt;)</a>
635+
</div>
633636
</article>
634637
</div>
635638

0 commit comments

Comments
 (0)