XmlDocExtensions.InspectDocumentation Method

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

Definition

Inspects the XML documentation for the specified member.
public static IEnumerable<XmlDocInspectionIssue> InspectDocumentation(this IXmlDocProvider xmlDocProvider, IMember member, XmlDocInspectionOptions options = XmlDocInspectionOptions.Required)

Parameters

xmlDocProvider IXmlDocProvider
The XML documentation provider to use.
member IMember
The member to inspect.
options XmlDocInspectionOptions optional
The options to determine which tags to inspect.

Returns

IEnumerable<XmlDocInspectionIssue>
An enumerable of XmlDocInspectionIssue instances representing the issues found.

Exceptions

ArgumentNullException
Thrown when xmlDocProvider or member is null.