table DocSectionBlock

Overview

DocSectionBlock = {
    -- fields

    id,

    -- inherited from DocBlock

    blockKind,
    title,
    text,
    childBlockList,
}

Detailed Documentation

Fields

id

Holds a Doxygen identifier.

This field is only set if blockKind is one of:

ref

section

simplesec

If blockKind is ref, then id describes the identifier of the hyperlink target.

For section blocks, id describes the identifier of the section itself.