XmlDocInspectionIssue Struct

Namespace

Kampute.DocToolkit.XmlDoc

Assembly

Definition

Represents an issue found during the inspection of XML documentation comments.

public readonly struct XmlDocInspectionIssue

Inheritance

CodeReference	Gets the code reference associated with the issue, if applicable.
Hyperlink	Gets the hyperlink reference associated with the issue, if applicable.
IssueType	Gets the type of issue.
Member	Gets the member associated with the issue.
Parameter	Gets the parameter associated with the issue, if applicable.
TypeParameter	Gets the type parameter associated with the issue, if applicable.
XmlTag	Gets the XML documentation tag associated with the issue.

MissingOptionalTag(IMember, XmlDocTag)	Initializes a new instance of the XmlDocInspectionIssue for a missing optional tag.
MissingRequiredTag(IMember, XmlDocTag)	Initializes a new instance of the XmlDocInspectionIssue for a missing required tag.
ToString()	Returns a string that represents the current issue.
UndocumentedParameter(IParameter)	Initializes a new instance of the XmlDocInspectionIssue for an undocumented parameter.
UndocumentedReference(IMember, XmlDocTag, string)	Initializes a new instance of the XmlDocInspectionIssue for an undocumented reference.
UndocumentedReturnParameter(IParameter)	Initializes a new instance of the XmlDocInspectionIssue for an undocumented return parameter.
UndocumentedTypeParameter(ITypeParameter)	Initializes a new instance of the XmlDocInspectionIssue for an undocumented type parameter.
UntitledSeeAlso(IMember, string)	Initializes a new instance of the XmlDocInspectionIssue for an untitled see-also reference.