HtmlFormat Class

Namespace
Kampute.DocToolkit.Formatters
Assembly
  • Kampute.DocToolkit.dll

Definition

Represents a documentation formatter that generates HTML content.
public class HtmlFormat : DocFormatter, IXmlDocReferenceAccessor
Inheritance
Implements

Remarks

The HtmlFormat class provides functionality for generating documentation in HTML format. It handles the transformation of XML documentation comments to HTML, proper encoding of HTML special characters, and supports various file extensions commonly associated with HTML files.

Use this formatter when you need to generate web-based documentation that can be viewed in browsers, including API reference websites and integrated help systems.

Constructors

HtmlFormat()Initializes a new instance of the HtmlFormat class.
HtmlFormat(string)Initializes a new instance of the HtmlFormat class with the specified file extension for the HTML files.

Properties

XmlDocTransformerGets the XML documentation transformer for the HTML format.

Methods

CreateMarkupWriter(TextWriter, bool)Creates an instance of MarkupWriter class that wraps the specified writer for encoding content in HTML format.
CreateMinifier(TextWriter)Creates a TextWriter instance that wraps the specified writer to minimize the content for HTML format.
Encode(ReadOnlySpan<char>, TextWriter)Encodes special HTML characters in the specified text and writes the encoded content to the specified writer.

Explicit Interface Implementations

IXmlDocReferenceAccessor.ReferenceResolverGets or sets the reference resolver for resolving references in XML documentation comments.

See Also