DocBuilder Constructor
Definition
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.
Constructs a new documentation builder instance.
public DocBuilder (string rootPath, System.Collections.Generic.IEnumerable<Microsoft.Quantum.QsCompiler.SyntaxTree.QsNamespace> tree, System.Collections.Generic.IEnumerable<string>? sources = default);new Microsoft.Quantum.QsCompiler.Documentation.DocBuilder : string * seq<Microsoft.Quantum.QsCompiler.SyntaxTree.QsNamespace> * seq<string> -> Microsoft.Quantum.QsCompiler.Documentation.DocBuilderPublic Sub New (rootPath As String, tree As IEnumerable(Of QsNamespace), Optional sources As IEnumerable(Of String) = Nothing)Parameters
- rootPath
- String
The root directory in which documentation files should be generated
- tree
- IEnumerable<QsNamespace>
The compiled namespaces to generate documentation for
- sources
- IEnumerable<String>
If specified, documentation is only generated for the specified source files.