MissingTags Enumeration

Sandcastle Help File Builder Documentation

SandcastleBuilder.Utils Namespaces

SandcastleBuilder.Utils

ApiEntryType Enumeration

ApiFilter Class

ApiFilterCollection Class

BaseBuildItem Class

BuildAction Enumeration

BuildAssemblerVerbosity Enumeration

BuilderException Class

CollectionTocStyle Enumeration

COMReferenceItem Class

ContentPlacement Enumeration

DocumentationSource Class

DocumentationSourceCollection Class

DocumentType Enumeration

FileItem Class

FileItemCollection Class

FilePath Class

FolderPath Class

HtmlSdkLinkType Enumeration

IBasePathProvider Interface

MissingTags Enumeration

MSHelp2SdkLinkType Enumeration

MSHelpAttr Class

MSHelpAttrCollection Class

MSHelpKeyword Class

MSHelpKeywordCollection Class

MSHelpViewerSdkLinkType Enumeration

NamespaceSummaryItem Class

NamespaceSummaryItemCollection Class

NamingMethod Enumeration

ProjectElement Class

ProjectFileConfiguration Class

ProjectPropertyChangedEventArgs Class

ProjectReferenceItem Class

PropertyBasedCollectionItem Class

ReferenceItem Class

ReferenceItemCollection Class

SandcastleProject Class

SdkLinkTarget Enumeration

Utility Class

VisibleItems Enumeration

MissingTags Enumeration

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

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

Syntax

C++

Copy

[SerializableAttribute]
[FlagsAttribute]
public enum MissingTags

<SerializableAttribute>
<FlagsAttribute>
Public Enumeration MissingTags

[SerializableAttribute]
[FlagsAttribute]
public enum class MissingTags

[<SerializableAttribute>]
[<FlagsAttribute>]
type 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.

Reference

SandcastleBuilder.Utils Namespace