MissingTags Enumeration

This public enumerated type defines the missing documentation tags for which to search.

Definition

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.2.18.0

[SerializableAttribute]
[FlagsAttribute]
public enum MissingTags

<SerializableAttribute>
<FlagsAttribute>
Public Enumeration MissingTags

[SerializableAttribute]
[FlagsAttribute]
public enum class MissingTags

[<SerializableAttribute>]
[<FlagsAttribute>]
type MissingTags

None	0x0000	Do not search for any missing tags.
Summary	0x0001	Search for missing <summary> tags.
Parameter	0x0002	Search for missing <param> tags.
Returns	0x0004	Search for missing <returns> tags.
Value	0x0008	Search for missing <value> tags.
Remarks	0x0010	Search for missing <remarks> tags.
AutoDocumentCtors	0x0020	Automatically document constructors if they are missing a <summary> tag.
Namespace	0x0040	Search for missing namespace comments.
TypeParameter	0x0080	Search for missing <typeparam> tags.
IncludeTargets	0x0100	Search for missing <include> target documentation.
AutoDocumentDispose	0x0200	Automatically document dispose methods if they are missing <summary> and/or <param> tag.