DocBuilder.Run Method

Reference

Definition

Namespace:: Microsoft.Quantum.QsCompiler.Documentation

Assembly:: Microsoft.Quantum.QsDocumentationParser.dll

Package:: Microsoft.Quantum.Compiler v0.25.218240

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Generates all of the documentation files for a build. Returns true if no exception occurred during generation, and false otherwise.

public static bool Run (string rootPath, System.Collections.Generic.IEnumerable<Microsoft.Quantum.QsCompiler.SyntaxTree.QsNamespace> tree, System.Collections.Generic.IEnumerable<string>? sources = default, Action<Exception>? onException = default);

static member Run : string * seq<Microsoft.Quantum.QsCompiler.SyntaxTree.QsNamespace> * seq<string> * Action<Exception> -> bool

Public Shared Function Run (rootPath As String, tree As IEnumerable(Of QsNamespace), Optional sources As IEnumerable(Of String) = Nothing, Optional onException As Action(Of Exception) = Nothing) As Boolean

Parameters

rootPath: String

The root directory in which documentation files should be generated. If this directory does not exist, it will be created and populated.

tree: IEnumerable<QsNamespace>

The compiled namespaces to generate documentation for.

sources: IEnumerable<String>

If specified, documentation is only generated for the specified source files.

onException: Action<Exception>

Called on caught exceptions before ignoring them.

Returns

Boolean

Applies to