Kampute.DocToolkit Namespace

Provides core components for document generation, processing, and rendering.

Remarks

This namespace contains types that coordinate the documentation generation process, including context management, composition of documentation elements, document rendering, and output generation.

These components implement the documentation pipeline, connecting metadata extraction, XML documentation processing, and format-specific output generation.

Classes

DevOpsWikiOptions	Provides options for generating documentation addresses compatible with Azure DevOps Wiki.
DevOpsWikiStrategy	Provides an addressing strategy for organizing and addressing documentation pages hosted on an Azure DevOps Wiki.
DocFxOptions	Provides options for generating documentation addresses compatible with DocFx.
DocFxStrategy	Provides an addressing strategy for organizing and addressing documentation pages in a manner similar to the DocFX documentation generator.
DocumentPageRenderer	Renders documentation pages for various code elements.
DocumentationComposer	Represents a base class for generating documentation pages.
DocumentationContext	Provides the context for generating documentation.
DocumentationContextBuilder	Represents a builder for creating DocumentationContext instances.
DocumentationContextBuilder<TContext>	Represents an abstract builder for creating documentation contexts, where the API documentation is provided by XML documentation files.
DocumentationContextExtensions	Provides extension methods for IDocumentationContext instances to simplify common tasks.
DotNetApiOptions	Provides options for generating documentation addresses compatible with .NET API documentation.
DotNetApiStrategy	Provides an addressing strategy for organizing and addressing documentation pages similar to the .NET API documentation structure hosted on Microsoft Learn.
FileSystemDocumentWriterFactory	Provides a file system-based implementation of the IDocumentWriterFactory interface for writing documentation content to the file system.
FileSystemDocumentationComposer	Represents a generator that creates documentation files for code elements in a given context.
FileTopicFactory	Provides methods for creating appropriate FileTopic instances based on file extensions.
OutputOptions	Provides options for output generation in the documentation process.

Interfaces

IDocumentModel	Defines a contract for a model in the documentation that can be rendered with a specific context.
IDocumentRenderer	Defines a contract for rendering documentation pages.
IDocumentWriterFactory	Defines a contract for creating TextWriter instances to write content of a specific documentation element.
IDocumentationContext	Defines a contract for providing the context for the documentation generation process.

Enums

DocumentationModelType	Represents the type of a documentation model.
PageCategory	Represents the documentation page categories.
PageGranularity	Specifies how documentation content is organized into addressable pages, affecting URLs and navigation structure.