XmlDocInspectionIssue.UndocumentedReference Method

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

Definition

Initializes a new instance of the XmlDocInspectionIssue for an undocumented reference.
public static XmlDocInspectionIssue UndocumentedReference(IMember member, XmlDocTag xmlTag, string cref)

Parameters

member IMember
The member with the undocumented reference.
xmlTag XmlDocTag
The XML documentation tag containing the reference.
cref string
The code reference that is not described.

Returns

XmlDocInspectionIssue
A new XmlDocInspectionIssue instance.

Exceptions

ArgumentNullException
Thrown when member or cref is null.