table Compound

Overview

Table of this type describes a Doxygen compound such as class, namespace, group etc. More…

Compound = {
    -- fields

    compoundKind,
    id,
    name,
    title,
    importId,
    group,
    path,
    importArray,
    briefDescription,
    detailedDescription,
    location,

    -- inherited from NamespaceContents

    groupArray,
    namespaceArray,
    enumArray,
    structArray,
    unionArray,
    classArray,
    interfaceArray,
    protocolArray,
    exceptionArray,
    serviceArray,
    singletonArray,
    typedefArray,
    variableArray,
    constructorArray,
    destructor,
    functionArray,
    propertyArray,
    eventArray,
    aliasArray,
    defineArray,
    footnoteArray,
}

Detailed Documentation

Table of this type describes a Doxygen compound such as class, namespace, group etc.

Fields

compoundKind

Holds a string describing compound type. Must be one of CompoundKind.

id

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

name

Holds a string with the name of the compound.

title

Holds a string with the title (if specified) or an empty string. Usually compound titles are not used unless this is a group compound.

path

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

briefDescription

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

detailedDescription

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

location

Holds a Location table describing the place of declaration.