IDocumentFormatter Interface
- Namespace
- Kampute.DocToolkit.Formatters
- Assembly
- Kampute.DocToolkit.dll
Definition
Defines a contract for a documentation formatter.
public interface IDocumentFormatter : ITextEncoder, IXmlDocTransformer- Extends
- Implemented by
Remarks
Properties
| FileExtension | Gets the file extension of the documentation files in the target format. |
| TextTransformers | Gets the transformers for converting text to the target format. |
Methods
| CreateMarkupWriter(TextWriter, bool) | Creates an instance of MarkupWriter class that wraps the specified writer for encoding content in the target format. |
| CreateMinifier(TextWriter) | Creates a TextWriter instance that wraps the specified writer to minimize the content for the target format. |
The IDocumentFormatter interface combines text encoding and XML documentation transformation capabilities to provide comprehensive documentation formatting.
Documentation formatters are responsible for:- Converting XML documentation comments to a target format (HTML, Markdown, etc.)
- Properly encoding text for the target format
- Creating specialized writers for dynamic document generation
- Supporting content minification for optimized output
Implementations typically support specific documentation formats, such as HTML or Markdown, and can be registered with the DocFormatProvider to be discovered by file extension.