Code
Runs asynchronous code examples
defined in the specified assembly, if any, or in the entry
assembly otherwise,
and writes to files their console outputs together with
the corresponding source code, if available.
Definition
Namespace: Novacta.Documentation.CodeExamples
Assembly: Novacta.Documentation.CodeExamples (in Novacta.Documentation.CodeExamples.dll) Version: 2.0.0+d0711904e187765f05e6dc698044fce33381798b
A list of CodeExampleInfo instances containing information about the code examples and the results of their execution.
Assembly: Novacta.Documentation.CodeExamples (in Novacta.Documentation.CodeExamples.dll) Version: 2.0.0+d0711904e187765f05e6dc698044fce33381798b
C#
public Task<List<CodeExampleInfo>> RunAsync(
bool reportExecutionInfo = true,
Assembly assembly = null
)VB
Public Function RunAsync (
Optional reportExecutionInfo As Boolean = true,
Optional assembly As Assembly = Nothing
) As Task(Of List(Of CodeExampleInfo))C++
public:
Task<List<CodeExampleInfo^>^>^ RunAsync(
bool reportExecutionInfo = true,
Assembly^ assembly = nullptr
)F#
member RunAsync :
?reportExecutionInfo : bool *
?assembly : Assembly
(* Defaults:
let _reportExecutionInfo = defaultArg reportExecutionInfo true
let _assembly = defaultArg assembly null
*)
-> Task<List<CodeExampleInfo>> Parameters
- reportExecutionInfo Boolean (Optional)
- if information about examples' execution must be reported; otherwise, .
- assembly Assembly (Optional)
- The assembly containing the code examples to run. It can be , in which case the entry assembly for the running application is used, as returned by GetEntryAssembly.
Return Value
TaskListCodeExampleInfoA list of CodeExampleInfo instances containing information about the code examples and the results of their execution.
Remarks
This method runs asynchronous code examples, i.e. those that implement the IAsyncCodeExample interface implicitly.
Caution
For a class to be recognized as an asynchronous code example,
it should not implement the
IAsyncCodeExample interface explicitly.