table Param

Overview

Table of this type describes a Doxygen param such as function argument or template parameter. More…

Param = {
    -- fields

    declarationName,
    definitionName,
    array,
    type,
    defaultValue,
    typeConstraint,
    briefDescription,
}

Detailed Documentation

Table of this type describes a Doxygen param such as function argument or template parameter.

Fields

declarationName

Holds a string describing a name given to the parameter during declaration.

definitionName

Holds a string describing a name given to the parameter during definition.

array

Holds a string describing array dimension suffix of the parameter (if the parameter is of array type).

type

Holds a LinkedText table describing the type of the parameter.

defaultValue

Holds a LinkedText table with the default value assigned to the parameter.

Sample:

int foo (int a, int b = 100);

defaultValue for a will be empty (LinkedText.isEmpty will be set to true).

defaultValue for b will contain = 100.

briefDescription

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