This public enumerated type defines the missing documentation tags for
which to search.
Namespace: SandcastleBuilder.UtilsAssembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 1.9.3.0
Syntax
| C# |
|---|
[SerializableAttribute] [FlagsAttribute] public enum MissingTags |
| Visual Basic |
|---|
<SerializableAttribute> _ <FlagsAttribute> _ Public Enumeration MissingTags |
Members
| Member name | Value | Description | |
|---|---|---|---|
| None | 0 | Do not search for any missing tags. | |
| Summary | 1 | Search for missing <summary> tags. | |
| Parameter | 2 | Search for missing <param> tags. | |
| Returns | 4 | Search for missing <returns> tags. | |
| Value | 8 | Search for missing <value> tags. | |
| Remarks | 16 | Search for missing <remarks> tags. | |
| AutoDocumentCtors | 32 | Automatically document constructors if they are missing a <summary> tag. | |
| Namespace | 64 | Search for missing namespace comments. | |
| TypeParameter | 128 | Search for missing <typeparam> tags. | |
| IncludeTargets | 256 | Search for missing <include> target documentation. | |
| AutoDocumentDispose | 512 | Automatically document dispose methods if they are missing <summary> and/or <param> tag. |
See Also
