# cxxEnumeration module

Defines a top-level container for all the elements necessary to describe an C++ API enumeration.

## Description

The <cxxEnumeration> topic type contains elements necessary to show the name of the enumeration, the enumeration syntax, and the enumeration use description. This topic type module also contains all the elements necessary to describe the component variables and functions.

The cxxEnumeration topic contains the following elements:

- cxxEnumeration
  The <cxxEnumeration> element contains all the elements needed to describe the declaration of a C++ enumeration.
- cxxEnumerationAccessSpecifier
  The <cxxEnumerationAccessSpecifier> element describes the access specifier for the enumeration.
- cxxEnumerationAPIItemLocation
  The <cxxEnumerationAPIItemLocation> element describes the location of an enumeration in the original C++ source code.
- cxxEnumerationDeclarationFile
  The <cxxEnumerationDeclarationFile> element is defined within <cxxEnumerationAPIItemLocation>. <cxxEnumerationDeclarationFile> specifies the file in which the API declaration is present.
- cxxEnumerationDeclarationFileLine
  The <cxxEnumerationDeclarationFileLine> element is defined within <cxxEnumerationAPIItemLocation>. <cxxEnumerationDeclarationFileLine> specifies the line on which the API is declared
- cxxEnumerationDefinition
  The <cxxEnumerationDefinition> element is defined within <cxxEnumerationDetail>. <cxxEnumerationDefinition> represents the C++ enumeration declaration.
- cxxEnumerationDefinitionFile
  The <cxxEnumerationDefinitionFile> element is defined within <cxxEnumerationAPIItemLocation>. <cxxEnumerationDefinitionFile> specifies the file in which the API definition is present.
- cxxEnumerationDefinitionFileLineEnd
  The <cxxEnumerationDefinitionFileLineEnd> element specifies the end of the enumeration definition.
- cxxEnumerationDefinitionFileLineStart
  The <cxxEnumerationDefinitionFileLineStart> element specifies the beginning of the enumeration definition.
- cxxEnumerationDetail
  The <cxxEnumerationDetail> element provides detailed information about the structure and behaviors of the C++ enumeration.
- cxxEnumerationNameLookup
  Provides a unique identifier of the enumeration.
- cxxEnumerationPrototype
  Provides a "visual" representation of the enumeration declaration.
- cxxEnumerationReimplemented
  Identifies enumerations that have been re-implemented.
- cxxEnumerationScopedName
  The scope of the enumeration i.e. the declaration of the enclosing namespace/class/struct/union.
- cxxEnumerator
  The <cxxEnumerator> element within the <cxxEnumerators> element provides the details of an enumerator defined within an enumeration.
- cxxEnumeratorAPIItemLocation
  The <cxxEnumeratorAPIItemLocation> element is defined within <cxxEnumerator>. <cxxEnumeratorAPIItemLocation> specifies the location of the API.
- cxxEnumeratorDeclarationFile
  The <cxxEnumeratorDeclarationFile> element is defined within <cxxEnumeratorAPIItemLocation>. <cxxEnumeratorDeclarationFile> specifies the file in which the API declaration is present.
- cxxEnumeratorDeclarationFileLine
  The <cxxEnumeratorDeclarationFileLine> element is defined within <cxxEnumeratorAPIItemLocation>. <cxxEnumeratorDeclarationFileLine> specifies the line on which the API is declared
- cxxEnumeratorInitialiser
  The <cxxEnumeratorInitialiser> element specifies the initial value of the enumerator.
- cxxEnumeratorNameLookup
  Provides a unique identifier of the enumerator.
- cxxEnumeratorPrototype
  Provides a "visual" representation of the enumerator declaration.
- cxxEnumerators
  The <cxxEnumerators> element contains a <cxxEnumerator> element for each enumerator in an enumeration
- cxxEnumeratorScopedName
  The scope of the enumerator i.e. the declaration of the enclosing namespace/class/struct/union.

Parent topic: C++ topic types