Kampute.DocToolkit.XmlDoc Namespace
Contains components for parsing, transforming, and processing XML documentation comments.
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
| XmlDocContextAwareReferenceResolver | Resolves XML documentation references using the current documentation context. |
| XmlDocEntry | Represents XML documentation for a namespace, type, or type member. |
| XmlDocErrorHandler | Reports errors that occur due to unresolved elements or references while processing XML documentation comments by invoking user-defined error handlers. |
| XmlDocExtensions | Provides extension methods for various XML documentation related types to simplify common tasks. |
| XmlDocNullReferenceResolver | Provides a resolver that performs no resolution for XML documentation references. |
| XmlDocProvider | Provides XML documentation for .NET types and members by parsing and resolving documentation files. |
| XmlDocProviderCache | A wrapper for IXmlDocProvider that adds caching support to improve performance for repeated queries. |
| XmlDocToHtmlTransformer | Converts the text content of XML documentation comments into HTML format using XSLT transformations. |
| XmlDocToMarkdownTransformer | Converts the text content of XML documentation comments into Markdown format using XSLT transformations. |
| XmlDocTransformer | Extracts and formats the text content of XML documentation comments using XSLT style-sheets. |
Structs
Interfaces
| IXmlDocErrorHandler | Defines a contract for reporting errors that occur due to unresolved elements or references while processing XML documentation comments. |
| IXmlDocProvider | Defines a contract for providing XML documentation for code references, types and type members. |
| IXmlDocReferenceAccessor | Defines a contract for accessing and managing the reference resolver, which is responsible for resolving references within XML documentation comments during transformation. |
| IXmlDocReferenceResolver | Provides methods for resolving context information related to XML documentation comments. |
| IXmlDocTransformer | Defines a contract for extracting and writing the text content of XML documentation comments. |
Enums