FileSystemDocumentWriterFactory Class

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll

Definition

Provides a file system-based implementation of the IDocumentWriterFactory interface for writing documentation content to the file system.
public class FileSystemDocumentWriterFactory : IDocumentWriterFactory
Inheritance
  • object
  • FileSystemDocumentWriterFactory
Implements

Remarks

The FileSystemDocumentWriterFactory provides a concrete implementation of IDocumentWriterFactory that creates rendering context for writing documentation content to the file system. This factory is responsible for:
  • Managing the output directory structure for documentation files
  • Resolving relative file paths for code elements and topics
  • Optionally applying content minification to the output
The factory works in conjunction with the document context's addressing strategy to determine where each piece of documentation should be placed in the output folder structure. By centralizing file path resolution and rendering context creation, it ensures consistent output location and format across the documentation generation process.

Constructors

FileSystemDocumentWriterFactory(string, OutputOptions)Initializes a new instance of the FileSystemDocumentWriterFactory class.

Properties

IsMinificationEnabledGets a value indicating whether the output minification is enabled.
OutputFolderGets the output folder for the documentation files.

Methods

CreateTextWriter(string)Creates a TextWriter for writing documentation content to the specified relative path.
CreateWriter(IDocumentModel)Creates an instance of TextWriter for rendering documentation content of the specified document model.