Skip to content

Commit 8a06f3e

Browse files
craigfowlercraigfowler
committed
Increment production documentation
1 parent d267c6a commit 8a06f3e

File tree

199 files changed

+29859
-6539
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

199 files changed

+29859
-6539
lines changed

‎docs/api/CSF.Validation.IHostsValidationFramework.html‎

Lines changed: 333 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/api/CSF.Validation.IQueryableValidationResult-1.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,9 @@ <h5>Inherited Members</h5>
9191
<div>
9292
<a class="xref" href="CSF.Validation.IQueryableValidationResult.html#CSF_Validation_IQueryableValidationResult_ManifestValue">IQueryableValidationResult.ManifestValue</a>
9393
</div>
94+
<div>
95+
<a class="xref" href="CSF.Validation.IQueryableValidationResult.html#CSF_Validation_IQueryableValidationResult_ValidationTime">IQueryableValidationResult.ValidationTime</a>
96+
</div>
9497
<div>
9598
<a class="xref" href="CSF.Validation.IQueryableValidationResult.html#CSF_Validation_IQueryableValidationResult_RuleResults">IQueryableValidationResult.RuleResults</a>
9699
</div>

‎docs/api/CSF.Validation.IQueryableValidationResult.html‎

Lines changed: 51 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h3 id="properties">Properties
102102
<a href="https://github.com/csf-dev/CSF.Validation/new/master/apiSpec/new?filename=CSF_Validation_IQueryableValidationResult_ManifestValue.md&amp;value=---%0Auid%3A%20CSF.Validation.IQueryableValidationResult.ManifestValue%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>
103103
</span>
104104
<span class="small pull-right mobile-hide">
105-
<a href="https://github.com/csf-dev/CSF.Validation/blob/production/CSF.Validation.Abstractions/IQueryableValidationResult.cs/#L20">View Source</a>
105+
<a href="https://github.com/csf-dev/CSF.Validation/blob/production/CSF.Validation.Abstractions/IQueryableValidationResult.cs/#L21">View Source</a>
106106
</span>
107107
<a id="CSF_Validation_IQueryableValidationResult_ManifestValue_" data-uid="CSF.Validation.IQueryableValidationResult.ManifestValue*"></a>
108108
<h4 id="CSF_Validation_IQueryableValidationResult_ManifestValue" data-uid="CSF.Validation.IQueryableValidationResult.ManifestValue">ManifestValue</h4>
@@ -112,7 +112,7 @@ <h4 id="CSF_Validation_IQueryableValidationResult_ManifestValue" data-uid="CSF.V
112112
<div class="markdown level1 conceptual"></div>
113113
<h5 class="decalaration">Declaration</h5>
114114
<div class="codewrapper">
115-
<pre><code class="lang-csharp hljs">IManifestItem ManifestValue { get; }</code></pre>
115+
<pre><code class="lang-csharp hljs">ManifestItem ManifestValue { get; }</code></pre>
116116
</div>
117117
<h5 class="propertyValue">Property Value</h5>
118118
<table class="table table-bordered table-striped table-condensed">
@@ -124,7 +124,7 @@ <h5 class="propertyValue">Property Value</h5>
124124
</thead>
125125
<tbody>
126126
<tr>
127-
<td><a class="xref" href="CSF.Validation.Manifest.IManifestItem.html">IManifestItem</a></td>
127+
<td><a class="xref" href="CSF.Validation.Manifest.ManifestItem.html">ManifestItem</a></td>
128128
<td></td>
129129
</tr>
130130
</tbody>
@@ -134,7 +134,7 @@ <h5 class="propertyValue">Property Value</h5>
134134
<a href="https://github.com/csf-dev/CSF.Validation/new/master/apiSpec/new?filename=CSF_Validation_IQueryableValidationResult_Passed.md&amp;value=---%0Auid%3A%20CSF.Validation.IQueryableValidationResult.Passed%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>
135135
</span>
136136
<span class="small pull-right mobile-hide">
137-
<a href="https://github.com/csf-dev/CSF.Validation/blob/production/CSF.Validation.Abstractions/IQueryableValidationResult.cs/#L14">View Source</a>
137+
<a href="https://github.com/csf-dev/CSF.Validation/blob/production/CSF.Validation.Abstractions/IQueryableValidationResult.cs/#L15">View Source</a>
138138
</span>
139139
<a id="CSF_Validation_IQueryableValidationResult_Passed_" data-uid="CSF.Validation.IQueryableValidationResult.Passed*"></a>
140140
<h4 id="CSF_Validation_IQueryableValidationResult_Passed" data-uid="CSF.Validation.IQueryableValidationResult.Passed">Passed</h4>
@@ -165,7 +165,7 @@ <h5 class="propertyValue">Property Value</h5>
165165
<a href="https://github.com/csf-dev/CSF.Validation/new/master/apiSpec/new?filename=CSF_Validation_IQueryableValidationResult_RuleResults.md&amp;value=---%0Auid%3A%20CSF.Validation.IQueryableValidationResult.RuleResults%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>
166166
</span>
167167
<span class="small pull-right mobile-hide">
168-
<a href="https://github.com/csf-dev/CSF.Validation/blob/production/CSF.Validation.Abstractions/IQueryableValidationResult.cs/#L26">View Source</a>
168+
<a href="https://github.com/csf-dev/CSF.Validation/blob/production/CSF.Validation.Abstractions/IQueryableValidationResult.cs/#L44">View Source</a>
169169
</span>
170170
<a id="CSF_Validation_IQueryableValidationResult_RuleResults_" data-uid="CSF.Validation.IQueryableValidationResult.RuleResults*"></a>
171171
<h4 id="CSF_Validation_IQueryableValidationResult_RuleResults" data-uid="CSF.Validation.IQueryableValidationResult.RuleResults">RuleResults</h4>
@@ -192,14 +192,57 @@ <h5 class="propertyValue">Property Value</h5>
192192
</tr>
193193
</tbody>
194194
</table>
195+
<span class="small pull-right mobile-hide">
196+
<span class="divider">|</span>
197+
<a href="https://github.com/csf-dev/CSF.Validation/new/master/apiSpec/new?filename=CSF_Validation_IQueryableValidationResult_ValidationTime.md&amp;value=---%0Auid%3A%20CSF.Validation.IQueryableValidationResult.ValidationTime%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>
198+
</span>
199+
<span class="small pull-right mobile-hide">
200+
<a href="https://github.com/csf-dev/CSF.Validation/blob/production/CSF.Validation.Abstractions/IQueryableValidationResult.cs/#L38">View Source</a>
201+
</span>
202+
<a id="CSF_Validation_IQueryableValidationResult_ValidationTime_" data-uid="CSF.Validation.IQueryableValidationResult.ValidationTime*"></a>
203+
<h4 id="CSF_Validation_IQueryableValidationResult_ValidationTime" data-uid="CSF.Validation.IQueryableValidationResult.ValidationTime">ValidationTime</h4>
204+
<div class="markdown level1 summary"><p>Gets a value indicating how long the validation process took.</p>
205+
</div>
206+
<div class="markdown level1 conceptual"></div>
207+
<h5 class="decalaration">Declaration</h5>
208+
<div class="codewrapper">
209+
<pre><code class="lang-csharp hljs">TimeSpan? ValidationTime { get; }</code></pre>
210+
</div>
211+
<h5 class="propertyValue">Property Value</h5>
212+
<table class="table table-bordered table-striped table-condensed">
213+
<thead>
214+
<tr>
215+
<th>Type</th>
216+
<th>Description</th>
217+
</tr>
218+
</thead>
219+
<tbody>
220+
<tr>
221+
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.TimeSpan</span>&gt;</td>
222+
<td></td>
223+
</tr>
224+
</tbody>
225+
</table>
226+
<h5 id="CSF_Validation_IQueryableValidationResult_ValidationTime_remarks">Remarks</h5>
227+
<div class="markdown level1 remarks"><p>
228+
This value will only be populated if <a class="xref" href="CSF.Validation.ValidationOptions.html#CSF_Validation_ValidationOptions_InstrumentRuleExecution">InstrumentRuleExecution</a> is set to <span class="xref">true</span>.
229+
Otherwise it will be <span class="xref">null</span>.
230+
</p>
231+
<p>
232+
When <a class="xref" href="CSF.Validation.ValidationOptions.html#CSF_Validation_ValidationOptions_EnableRuleParallelization">EnableRuleParallelization</a> is <span class="xref">true</span> the sum of the times reported within each
233+
<a class="xref" href="CSF.Validation.ValidationRuleResult.html#CSF_Validation_ValidationRuleResult_InstrumentationData">InstrumentationData</a> will likely not total the amount reported by this property. That is because
234+
many of the reported times for each of the rules will have run concurrently with other rules.
235+
On the other hand, this time does correspond to real &quot;wall clock&quot; time to perform validation.
236+
</p>
237+
</div>
195238
<h3 id="methods">Methods
196239
</h3>
197240
<span class="small pull-right mobile-hide">
198241
<span class="divider">|</span>
199242
<a href="https://github.com/csf-dev/CSF.Validation/new/master/apiSpec/new?filename=CSF_Validation_IQueryableValidationResult_AsResultFor__1.md&amp;value=---%0Auid%3A%20CSF.Validation.IQueryableValidationResult.AsResultFor%60%601%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>
200243
</span>
201244
<span class="small pull-right mobile-hide">
202-
<a href="https://github.com/csf-dev/CSF.Validation/blob/production/CSF.Validation.Abstractions/IQueryableValidationResult.cs/#L34">View Source</a>
245+
<a href="https://github.com/csf-dev/CSF.Validation/blob/production/CSF.Validation.Abstractions/IQueryableValidationResult.cs/#L52">View Source</a>
203246
</span>
204247
<a id="CSF_Validation_IQueryableValidationResult_AsResultFor_" data-uid="CSF.Validation.IQueryableValidationResult.AsResultFor*"></a>
205248
<h4 id="CSF_Validation_IQueryableValidationResult_AsResultFor__1" data-uid="CSF.Validation.IQueryableValidationResult.AsResultFor``1">AsResultFor&lt;T&gt;()</h4>
@@ -263,7 +306,7 @@ <h5 class="exceptions">Exceptions</h5>
263306
<a href="https://github.com/csf-dev/CSF.Validation/new/master/apiSpec/new?filename=CSF_Validation_IQueryableValidationResult_ToSerializableResult.md&amp;value=---%0Auid%3A%20CSF.Validation.IQueryableValidationResult.ToSerializableResult%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>
264307
</span>
265308
<span class="small pull-right mobile-hide">
266-
<a href="https://github.com/csf-dev/CSF.Validation/blob/production/CSF.Validation.Abstractions/IQueryableValidationResult.cs/#L50">View Source</a>
309+
<a href="https://github.com/csf-dev/CSF.Validation/blob/production/CSF.Validation.Abstractions/IQueryableValidationResult.cs/#L68">View Source</a>
267310
</span>
268311
<a id="CSF_Validation_IQueryableValidationResult_ToSerializableResult_" data-uid="CSF.Validation.IQueryableValidationResult.ToSerializableResult*"></a>
269312
<h4 id="CSF_Validation_IQueryableValidationResult_ToSerializableResult" data-uid="CSF.Validation.IQueryableValidationResult.ToSerializableResult">ToSerializableResult()</h4>
@@ -311,7 +354,7 @@ <h5 id="CSF_Validation_IQueryableValidationResult_ToSerializableResult_remarks">
311354
<a href="https://github.com/csf-dev/CSF.Validation/new/master/apiSpec/new?filename=CSF_Validation_IQueryableValidationResult.md&amp;value=---%0Auid%3A%20CSF.Validation.IQueryableValidationResult%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>
312355
</li>
313356
<li>
314-
<a href="https://github.com/csf-dev/CSF.Validation/blob/production/CSF.Validation.Abstractions/IQueryableValidationResult.cs/#L9" class="contribution-link">View Source</a>
357+
<a href="https://github.com/csf-dev/CSF.Validation/blob/production/CSF.Validation.Abstractions/IQueryableValidationResult.cs/#L10" class="contribution-link">View Source</a>
315358
</li>
316359
</ul>
317360
</div>

0 commit comments

Comments
 (0)