XmlDocInspectionOptions Enum

Namespace

Kampute.DocToolkit.XmlDoc

Assembly

Kampute.DocToolkit.dll

Definition

Specifies the options for inspecting XML documentation of members.

[Flags]
public enum XmlDocInspectionOptions

Attributes

FlagsAttribute

Inheritance

object
ValueType
Enum
XmlDocInspectionOptions

Fields

Name	Value	Description
None	0	No issues will be reported.
Summary	1	Report missing or empty `summary` tags.
TypeParam	2	Report missing or empty `typeparam` tags.
Param	4	Report missing or empty `param` tags.
Returns	8	Report missing or empty `returns` tags.
Value	16	Report missing documentation for a property's value.
Exception	32	Report missing descriptions for exceptions thrown by a member.
Permission	64	Report missing descriptions for permissions required by a member.
Event	128	Report missing descriptions for events triggered by a member.
SeeAlso	256	Report `see-also` hyperlinks that lack descriptive titles.
Remarks	512	Report missing or empty `remarks` tags.
Example	1024	Report missing or empty `example` tags.
ThreadSafety	2048	Report missing documentation regarding thread safety for class and struct types.
Overloads	4096	Report missing shared summary documentation for overloaded members.
OmitImplicitlyCreatedConstructors	8192	Omit reporting missing `summary` tags for default public constructors that have no overloads.
Required	15	Report issues related to the minimum required documentation. These include missing or empty `summary`, `typeparam`, `param`, and `returns` tags.
Recommended	511	Report issues related to the recommended documentation. These include all required documentation issues plus `value`, `exception`, `permission`, `event`, and `see-also` tags.
All	8191	Report all issues.

Remarks

The XmlDocInspectionOptions enum provides a flexible way to configure which types of XML documentation issues should be reported during documentation inspection and validation.

Extension Methods

HasAnyChecks(this XmlDocInspectionOptions)

Determines whether any inspection checks are enabled.