IXmlDocTransformer Interface

Namespace
Kampute.DocToolkit.XmlDoc
Assembly
  • Kampute.DocToolkit.dll

Definition

Defines a contract for extracting and writing the text content of XML documentation comments.
public interface IXmlDocTransformer
Implemented by

Remarks

The IXmlDocTransformer interface is a core component of the documentation generation pipeline that converts XML documentation comments into various output formats such as HTML or Markdown.

Implementations of this interface take XML elements containing documentation comments and transform them into the desired output format. The transformation process typically involves parsing the XML structure, interpreting documentation tags, and resolving any references such as cross-references to other types or members.

This interface is intentionally minimal, focusing solely on the transformation capability, which makes it easy to create different transformers for various output formats while maintaining a consistent API.

Methods

Transform(TextWriter, XElement)Writes the transformed content of the XML comment element to the specified TextWriter.

See Also