DocumentationContextBuilder<TContext> Class
- Namespace
- Kampute.DocToolkit
- Assembly
- Kampute.DocToolkit.dll
Definition
Represents an abstract builder for creating documentation contexts, where the API documentation is provided by XML documentation files.
public abstract class DocumentationContextBuilder<TContext>
where TContext : IDocumentationContext- Inheritance
- object
- DocumentationContextBuilder<TContext>
- Inherited by
Type Parameters
TContext- The type of documentation context to build.
Remarks
This class provides a fluent interface for configuring and building documentation contexts. It supports chaining configuration methods to set up assemblies, XML documentation files, topics, and various options before creating the final context.
Constructors
| DocumentationContextBuilder<TContext>() | Initializes a new instance of the DocumentationContextBuilder class. |
Properties
| AssemblyPaths | Gets the collection of assembly files to document. |
| BaseUrl | Gets or sets the base URL for documentation links. |
| ExternalReferences | Gets the collection of API documentation resolvers for external references. |
| Language | Gets the programming language for syntax formatting. |
| Strategy | Gets the document addressing strategy. |
| Topics | Gets the collection of top-level topics to include in the documentation. |
| XmlDocErrorHandler | Gets the XML documentation error handler. |
| XmlDocPaths | Gets the collection of XML documentation file paths. |
Methods
| AddAssembly(string) | Adds an assembly file to the documentation if it has not been added before. |
| AddExternalReference(IRemoteApiDocUrlResolver) | Adds an API documentation resolver for external references. |
| AddTopic(ITopic) | Adds a top-level topic, including its subtopics, to the documentation. |
| AddTopic(string, string) | Adds a top-level topic to the documentation using the specified topic ID and file path. |
| AddXmlDoc(string) | Adds an XML documentation file to the documentation. |
| Build() | Builds the documentation context with the configured settings. |
| CreateAddressProvider(IEnumerable<IAssembly>) | Creates the document address provider based on the configured settings. |
| CreateContext() | Creates a new instance of TContext with the configured settings. |
| CreateFormatter() | Creates the document formatter based on the configured settings. |
| CreateMetadataUniverse() | Creates the metadata universe based on the configured assembly paths. |
| CreateXmlDocProvider() | Creates the XML documentation provider based on the configured settings. |
| LoadAssembliesFromPaths(MetadataUniverse) | Loads assemblies from the configured assembly paths. |
| WithBaseUrl(string) | Sets the base URL for documentation links. |
| WithBaseUrl(Uri) | Sets the base URL for documentation links. |
| WithLanguage(IProgrammingLanguage) | Sets the programming language for syntax formatting. |
| WithXmlDocErrorHandler(IXmlDocErrorHandler) | Sets the XML documentation error handler. |