DocumentationContextBuilder Class

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll

Definition

Represents a builder for creating DocumentationContext instances.
public class DocumentationContextBuilder : DocumentationContextBuilder<DocumentationContext>
Inheritance

Remarks

This class provides a concrete implementation of the abstract builder pattern for creating documentation contexts. It validates the required configuration and assembles all components into a functional documentation context.

Constructors

DocumentationContextBuilder(IDocumentAddressingStrategy)Initializes a new instance of the DocumentationContextBuilder class.

Properties

StrategyGets the document addressing strategy.

Methods

CreateContext()Creates a new instance of DocumentationContext with the configured settings.
DevOpsWiki(DevOpsWikiOptions)Creates a new instance of DocumentationContextBuilder for building documentation context to generate Markdown pages for Azure DevOps Wiki.
DocFx(DocFxOptions)Creates a new instance of DocumentationContextBuilder for building documentation context to generate HTML pages with structure matching DocFX conventions.
DotNetApi(DotNetApiOptions)Creates a new instance of DocumentationContextBuilder for building documentation context to generate HTML pages with structure matching .NET API browser conventions.