Code
Runs synchronous 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 List<CodeExampleInfo> Run(
bool reportExecutionInfo = true,
Assembly assembly = null
)VB
Public Function Run (
Optional reportExecutionInfo As Boolean = true,
Optional assembly As Assembly = Nothing
) As List(Of CodeExampleInfo)C++
public:
List<CodeExampleInfo^>^ Run(
bool reportExecutionInfo = true,
Assembly^ assembly = nullptr
)F#
member Run :
?reportExecutionInfo : bool *
?assembly : Assembly
(* Defaults:
let _reportExecutionInfo = defaultArg reportExecutionInfo true
let _assembly = defaultArg assembly null
*)
-> 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 is used, as returned by GetEntryAssembly.
Return Value
ListCodeExampleInfoA list of CodeExampleInfo instances containing information about the code examples and the results of their execution.
Remarks
This method runs synchronous code examples, i.e. those that implicitly implement the ICodeExample interface.
Caution
For a class to be recognized as a synchronous code example, it should not
implement the
ICodeExample interface explicitly.