XmlDocErrorHandler Class
- Namespace
- Kampute.DocToolkit.XmlDoc
- Assembly
- Kampute.DocToolkit.dll
Definition
Reports errors that occur due to unresolved elements or references while processing XML documentation comments by invoking user-defined error handlers.
public sealed class XmlDocErrorHandler : IXmlDocErrorHandler- Inheritance
- object
- XmlDocErrorHandler
- Implements
Remarks
This class provides a flexible error handling mechanism for XML documentation processors. It allows consumers to register custom delegates that will be invoked when specific XML documentation errors occur, such as missing include files or unresolved inheritdoc references.
Constructors
| XmlDocErrorHandler() | Initializes a new instance of the XmlDocErrorHandler class. |
Properties
| IncludeFileNotFoundError | Gets or sets the delegate for handling missing include file errors. |
| IncludeMemberNotFoundError | Gets or sets the delegate for handling unresolved include member path errors. |
| InheritDocNotFoundError | Gets or sets the delegate for handling unresolved inheritdoc element errors. |
Explicit Interface Implementations
| IXmlDocErrorHandler.IncludeFileNotFound(XElement, string) | Reports that the file attribute of an include element references a file that does not exist. |
| IXmlDocErrorHandler.IncludeMemberNotFound(XElement) | Reports that the path attribute of an include element references an XPath that cannot be resolved. |
| IXmlDocErrorHandler.InheritDocNotFound(XElement) | Reports that an inheritdoc element is used in a context where it cannot be resolved. |