CodeExamplesAnalyzerRun Method

Runs the code examples defined in the calling assembly, and writes to files their console outputs together with the corresponding source code, if any.

Namespace: Novacta.Documentation.CodeExamples
Assembly: Novacta.Documentation.CodeExamples (in Novacta.Documentation.CodeExamples.dll) Version: 1.0.0

Syntax

C++

Copy

public List<CodeExampleInfo> Run(
	bool reportExecutionInfo = true
)

Public Function Run ( 
	Optional reportExecutionInfo As Boolean = true
) As List(Of CodeExampleInfo)

public:
List<CodeExampleInfo^>^ Run(
	bool reportExecutionInfo = true
)

member Run : 
        ?reportExecutionInfo : bool 
(* Defaults:
        let _reportExecutionInfo = defaultArg reportExecutionInfo true
*)
-> List<CodeExampleInfo>

Parameters

reportExecutionInfo (Optional): Type: SystemBoolean
true if information about examples' execution must be reported; otherwise false.

Return Value

Type: ListCodeExampleInfo
A list of CodeExampleInfo instances containing information about the code examples and the results of their execution.

Reference

CodeExamplesAnalyzer Class

Novacta.Documentation.CodeExamples Namespace

CodeExamplesAnalyzerAddLanguageSpecificTextSet("LST8BF639ED_0?cpp=::|nu=.");Run Method

Parameters

Return Value

Reference

CodeExamplesAnalyzerRun Method