DocumentationContextExtensions.InspectDocumentations Method

Namespace
Kampute.DocToolkit
Assembly
  • Kampute.DocToolkit.dll

Definition

Inspects the documentation of members in the context for missing or incomplete elements.
public static IEnumerable<XmlDocInspectionIssue> InspectDocumentations(this IDocumentationContext context, XmlDocInspectionOptions options = XmlDocInspectionOptions.Required)

Parameters

context IDocumentationContext
The documentation context 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 context is null.

Remarks

This method inspects the XML documentation comments of all members in the context and yields issues for missing or incomplete documentation elements. It leverages cached documentation from model instances to avoid redundant lookups.