XmlDocExtensions Class

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

Definition

Provides extension methods for various XML documentation related types to simplify common tasks.
public static class XmlDocExtensions
Inheritance

Methods

HasAnyChecks(this XmlDocInspectionOptions)Determines whether any inspection checks are enabled.
Inspect(this XmlDocEntry, IMember, XmlDocInspectionOptions, Func<IMember, XmlDocEntry>)Inspects the XML documentation entry for missing or incomplete elements based on the provided member and inspection options.
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.