Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
IR::CatalogEntryGroup Struct Reference

\variable IR::CatalogEntry::name Display name of the entry, as returned by node->fullName(relative) at extraction time. More...

#include <catalogentry.h>

Collaboration diagram for IR::CatalogEntryGroup:

Public Attributes

QString label
QString anchorId
QList< CatalogEntry > entries

Detailed Description

\variable IR::CatalogEntry::name Display name of the entry, as returned by node->fullName(relative) at extraction time.

The name is relative-aware: common prefixes with the current page are stripped when the page context allows.

\variable IR::CatalogEntry::href Pre-resolved link target. Resolved by HrefResolver at extraction time so catalog expansion avoids a second pass through the link resolver. Empty when the entry is suppressed by the inclusion policy.

\variable IR::CatalogEntry::brief Plain-text brief description. For code-backed nodes such as classes, this comes from Doc::trimmedBriefText; for text pages such as example index pages, it comes from Node::reconstitutedBrief with a fallback to Doc::briefText. The brief is flattened to text at extraction time because legacy catalog rendering doesn't apply inline formatting within catalog tables.

\variable IR::CatalogEntry::since The version string declared via \since on the documented entity, or empty when no since stamp is present.

\variable IR::CatalogEntry::isDeprecated True when the documented entity is marked deprecated. Catalog renderers can use this to apply a strike-through style or to filter the entry, matching whichever behavior the consuming template prescribes.

A labeled group of catalog entries, used by variants such as \generatelist annotatedexamples that partition their entries by module or by category.

CatalogEntryGroup pairs a display label and an anchor identifier with a list of entries. The list-expander pass emits one SectionHeading plus one Table per group when rendering a grouped catalog variant.

See also
CatalogEntry

Definition at line 23 of file catalogentry.h.

Member Data Documentation

◆ anchorId

QString IR::CatalogEntryGroup::anchorId

Definition at line 26 of file catalogentry.h.

◆ entries

QList<CatalogEntry> IR::CatalogEntryGroup::entries

Definition at line 27 of file catalogentry.h.

◆ label

QString IR::CatalogEntryGroup::label

Definition at line 25 of file catalogentry.h.

The documentation for this struct was generated from the following file: