Code
Runs synchronous code examples
defined in the entry
assembly for the running application,
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#
[ObsoleteAttribute("Use Run(bool, Assembly) instead.")]
public List<CodeExampleInfo> Run(
bool reportExecutionInfo
)VB
<ObsoleteAttribute("Use Run(bool, Assembly) instead.")>
Public Function Run (
reportExecutionInfo As Boolean
) As List(Of CodeExampleInfo)C++
public:
[ObsoleteAttribute(L"Use Run(bool, Assembly) instead.")]
List<CodeExampleInfo^>^ Run(
bool reportExecutionInfo
)F#
[<ObsoleteAttribute("Use Run(bool, Assembly) instead.")>]
member Run :
reportExecutionInfo : bool -> List<CodeExampleInfo> Parameters
- reportExecutionInfo Boolean
- if information about examples' execution must be reported; otherwise, .
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. These examples must be defined in the entry assembly for the running application, as returned by GetEntryAssembly.
Caution
For a class to be recognized as a synchronous code example, it should not
implement the
ICodeExample interface explicitly.
To run code examples defined in a different assembly, use method Run(Boolean, Assembly).