IXmlDocErrorHandler Interface

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

Definition

Defines a contract for reporting errors that occur due to unresolved elements or references while processing XML documentation comments.
public interface IXmlDocErrorHandler
Implemented by

Remarks

This interface provides a standardized way to handle error conditions that occur during XML documentation processing. Implementations should provide meaningful error reporting while allowing the documentation processor to continue processing other elements when possible.

Methods

IncludeFileNotFound(XElement, string)Reports that the file attribute of an include element references a file that does not exist.
IncludeMemberNotFound(XElement)Reports that the path attribute of an include element references an XPath that cannot be resolved.
InheritDocNotFound(XElement)Reports that an inheritdoc element is used in a context where it cannot be resolved.

See Also