Kampute.DocToolkit.XmlDoc Namespace

Contains components for parsing, transforming, and processing XML documentation comments.

Remarks

This namespace includes classes for loading, parsing, and processing XML documentation comments from XML documentation files. These components extract documentation content and transform it into structured documentation models for output.

Format-specific transformers in this namespace convert XML documentation into output formats such as HTML and Markdown, applying format-specific structure and syntax.

Classes

XmlDocContextAwareReferenceResolverResolves XML documentation references using the current documentation context.
XmlDocEntryRepresents XML documentation for a namespace, type, or type member.
XmlDocErrorHandlerReports errors that occur due to unresolved elements or references while processing XML documentation comments by invoking user-defined error handlers.
XmlDocExtensionsProvides extension methods for various XML documentation related types to simplify common tasks.
XmlDocNullReferenceResolverProvides a resolver that performs no resolution for XML documentation references.
XmlDocProviderProvides XML documentation for .NET types and members by parsing and resolving documentation files.
XmlDocProviderCacheA wrapper for IXmlDocProvider that adds caching support to improve performance for repeated queries.
XmlDocToHtmlTransformerConverts the text content of XML documentation comments into HTML format using XSLT transformations.
XmlDocToMarkdownTransformerConverts the text content of XML documentation comments into Markdown format using XSLT transformations.
XmlDocTransformerExtracts and formats the text content of XML documentation comments using XSLT style-sheets.

Structs

XmlDocInspectionIssueRepresents an issue found during the inspection of XML documentation comments.

Interfaces

IXmlDocErrorHandlerDefines a contract for reporting errors that occur due to unresolved elements or references while processing XML documentation comments.
IXmlDocProviderDefines a contract for providing XML documentation for code references, types and type members.
IXmlDocReferenceAccessorDefines a contract for accessing and managing the reference resolver, which is responsible for resolving references within XML documentation comments during transformation.
IXmlDocReferenceResolverProvides methods for resolving context information related to XML documentation comments.
IXmlDocTransformerDefines a contract for extracting and writing the text content of XML documentation comments.

Enums

XmlDocInspectionIssueTypeSpecifies the type of issue found during the inspection of XML documentation comments.
XmlDocInspectionOptionsSpecifies the options for inspecting XML documentation of members.
XmlDocTagRepresents a top-level XML documentation tag.