table EnumValue

Overview

Table of this type describes Doxygen enum value. More…

EnumValue = {
    -- fields

    protectionKind,
    id,
    name,
    memberKind,
    path,
    initializer,
    briefDescription,
    detailedDescription,
}

Detailed Documentation

Table of this type describes Doxygen enum value.

Fields

protectionKind

Holds a string describing protection of the enum value. Must be one of ProtectionKind. Usually it’s just public.

id

Holds Doxygen identifier string, e.g. group__operators_1ggae611bfb523eb332069f2b7030accb66. This string can be used as a unique identifier for creating labels and reference links.

name

Holds a string with the name of the enum value.

memberKind

Holds a string containing member kind; for EnumValue always set to ``"enummember"

initializer

Holds a LinkedText table with the manually defined value.

Sample:

enum MyEnum
{
    MyEnum_Value1,
    MyEnum_Value2 = 100,
}

initializer for MyEnum_Value1 will be empty (LinkedText.isEmpty will be set to true).

initializer for MyEnum_Value2 will contain = 100.

briefDescription

Holds a Description table with the brief description of the enum value.

detailedDescription

Holds a Description table with the detailed description of the enum value.