XmlDocErrorHandler.IXmlDocErrorHandler.InheritDocNotFound Method

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

Definition

Reports that an inheritdoc element is used in a context where it cannot be resolved.
void IXmlDocErrorHandler.InheritDocNotFound(XElement memberElement)

Parameters

memberElement XElement
The member element containing the inheritdoc element.

Remarks

The following are situations where an inheritdoc element cannot be resolved:
  • The inheritdoc element has a cref or path attribute that cannot be resolved.
  • The inheritdoc has no attributes and the target element is neither overriding a member from a base class nor implementing an interface member, or the inherited member is without XML documentation comment.
It is the responsibility of the implementation to decide how to handle this error. If the implementation does not throw an exception, the error is ignored by the XML documentation processor.