FileSystemDocumentationComposer Class

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll

Definition

Represents a generator that creates documentation files for code elements in a given context.
public class FileSystemDocumentationComposer : DocumentationComposer
Inheritance

Remarks

The FileSystemDocumentationComposer class provides a concrete implementation for generating complete API documentation sets. As a subclass of DocumentationComposer, it orchestrates the entire documentation generation process by rendering documentation pages and writing them to a specified output folder.

This class serves as the main entry point for the documentation generation process, taking a documentation context (containing assemblies and XML documentations) and producing organized documentation files. It handles both the logical organization of documentation content and the physical file output.

Typical usage involves:
  1. Configuring a documentation context with assemblies and XML documentation sources
  2. Creating an instance of FileSystemDocumentationComposer
  3. Calling GenerateDocumentation(IDocumentationContext, string, OutputOptions) to produce the complete set of documentation files for the specified context in the desired output folder.

Constructors

FileSystemDocumentationComposer(IDocumentRenderer)Initializes a new instance of the FileSystemDocumentationComposer class.

Properties

RendererGets the documentation renderer.

Methods

GenerateDocumentation(IDocumentationContext, string, OutputOptions)Generates documentation pages for the specified context and writes the output to the specified folder.

See Also