IXmlDocProvider Interface
- Namespace
- Kampute.DocToolkit.XmlDoc
- Assembly
- Kampute.DocToolkit.dll
Definition
Defines a contract for providing XML documentation for code references, types and type members.
public interface IXmlDocProvider- Implemented by
Remarks
Properties
| HasDocumentation | Gets a value indicating whether the XML documentation provider has any documentation available. |
Methods
| TryGetDoc(string, out XmlDocEntry) | Attempts to retrieves the XML documentation for the specified code reference. |
Extension Methods
| InspectDocumentation(this IXmlDocProvider, IMember, XmlDocInspectionOptions) | Inspects the XML documentation for the specified member. |
| TryGetMemberDoc(this IXmlDocProvider, IMember, out XmlDocEntry) | Attempts to retrieves the XML documentation for the specified member. |
| TryGetNamespaceDoc(this IXmlDocProvider, string, out XmlDocEntry) | Attempts to retrieves the XML documentation for the specified namespace. |
| WithCaching(this IXmlDocProvider) | Wraps the specified IXmlDocProvider instance in a caching layer if it is not already cached. |
The IXmlDocProvider interface defines the core functionality for retrieving documentation associated with types and members within an assembly.
Implementations of this interface are responsible for:- Loading and parsing XML documentation from various sources
- Resolving documentation requests by code reference or reflection member
- Managing the internal storage and retrieval of documentation content
The XmlDocProvider class is a concrete implementation of this interface that loads XML documentation from XML files generated during compilation.