table Member

Overview

Table of this type describes a Doxygen member such as variable, function, typedef etc. More…

Member = {
    -- fields

    memberKind,
    protectionKind,
    virtualKind,
    flags,
    id,
    name,
    modifiers,
    group,
    importArray,
    path,
    briefDescription,
    detailedDescription,
    inBodyDescription,
    location,
}

Detailed Documentation

Table of this type describes a Doxygen member such as variable, function, typedef etc.

Fields

memberKind

Holds a string describing member type. Must be one of MemberKind.

protectionKind

Holds a string describing protection of the member. Must be one of ProtectionKind.

virtualKind

Holds a string describing whether this member is virtual or not. Must be one of VirtualKind.

flags

An empty string or a space-delimited combination of MemberFlag values.

id

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

name

Holds a string with the name of the member.

modifiers

Holds a string with space-separated list of language-specific modifiers applied to the member.

path

Holds a string with a forward-slash-separated path to the enum starting from the global namespace. For example, C++ enum io::NetworkAdapterType will have its path encoded as io/NetworkAdapterType. This field can be used to reconstruct a fully qualified name of the enum.

briefDescription

Holds a Description table with the brief description of the member.

detailedDescription

Holds a Description table with the detailed description of the member.

inBodyDescription

Holds a Description table with the in-body description of the member.

location

Holds a Location table describing the place of declaration.