XmlDocProvider.ResolveInheritDoc Method

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

Definition

Resolves the inheritdoc elements in the specified XML element.
protected virtual bool ResolveInheritDoc(XElement element)

Parameters

element XElement
The element to resolve its inheritdoc element.

Returns

bool
true if the inheritdoc element was resolved; otherwise, false.

Exceptions

ArgumentNullException
Thrown when element is null.

Remarks

This method attempts to resolve each inheritdoc element by finding the base member's documentation and merging it into the current element.

If an inheritdoc element has a cref or path attribute, it uses that to find the base member. If not, it attempts to infer the inherited member from the current element's name attribute. If the base member's documentation is found, its child elements are copied into the current element, and the inheritdoc element is removed.