XmlDocProvider Class

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

Definition

Provides XML documentation for .NET types and members by parsing and resolving documentation files.
public class XmlDocProvider : IXmlDocProvider
Inheritance
Implements

Constructors

XmlDocProvider(IXmlDocResolver)Initializes a new instance of the XmlDocProvider class.

Properties

HasDocumentationGets a value indicating whether the XML documentation provider has any documentation available.
ResolverGets the XML documentation resolver used by this provider.

Methods

TryGetMemberDoc(IMember, out XmlDocEntry)Attempts to retrieves the XML documentation for the specified member.
TryGetNamespaceDoc(string, out XmlDocEntry)Attempts to retrieves the XML documentation for the specified namespace.

Extension Methods

InspectDocumentation(this IXmlDocProvider, IMember, XmlDocInspectionOptions)Inspects the XML documentation for the specified member.