TestimoX

API Reference

Class

TestimoXDocumentationFindingAdapter

Edit on GitHub
Namespace TestimoX.Documentation
Assembly TestimoX
Source TestimoX/Documentation/TestimoXDocumentationFindingAdapter.cs:24
Modifiers static

Projects TestimoX rule execution results into renderer-neutral documentation findings.

Inheritance

  • Object
  • TestimoXDocumentationFindingAdapter

Methods

public static IReadOnlyList<DocumentationFinding> CreateFindings(IEnumerable<RuleComplete> ruleResults, TestimoXDocumentationFindingOptions options = null) #
TestimoX/Documentation/TestimoXDocumentationFindingAdapter.cs:24
Returns: IReadOnlyList<DocumentationFinding>

Creates documentation findings from TestimoX rule results.

Parameters

ruleResults System.Collections.Generic.IEnumerable{TestimoX.Definitions.RuleComplete} requiredposition: 0
Completed TestimoX rule results.
options TestimoX.Documentation.TestimoXDocumentationFindingOptions = null optionalposition: 1
Projection options.

Returns

Renderer-neutral documentation findings.