IXmlDocResolver Interface

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

Definition

Defines a contract for providing XML documentation elements associated with code references.
public interface IXmlDocResolver
Implemented by

Remarks

The IXmlDocErrorHandler interface defines the core functionality for retrieving documentation elements associated with a code reference.

Implementations of this interface are responsible for resolving inherited and included documentation as needed.

Properties

HasDocumentationGets a value indicating whether the resolver contains any XML documentation.

Methods

TryGetXmlDoc(string, out XElement)Attempts to retrieves the XML documentation for the specified code reference.

See Also