A single entry in a catalog page such as the classes index, the examples index, or a group's members table. More...

#include <catalogentry.h>

Collaboration diagram for IR::CatalogEntry:

Public Attributes
QString	name
QString	href
QString	brief
QString	since
bool	isDeprecated { false }

Detailed Description

A single entry in a catalog page such as the classes index, the examples index, or a group's members table.

CatalogEntry carries the fields that legacy HtmlGenerator reads when rendering an annotated-list row: the display name, the pre-resolved link target, and a brief description. A since-version stamp and a deprecation flag round out the shape so catalog renderers can mark versioned or deprecated entries without reaching back into Node state.

CatalogEntry is a QDocLib value type with no Node, Generator, Config, or Tree dependencies. Driver-side extraction populates it; the list-expander pass consumes it.

See also: CatalogEntryGroup

Definition at line 14 of file catalogentry.h.

Member Data Documentation

◆ brief

QString IR::CatalogEntry::brief

Definition at line 18 of file catalogentry.h.

◆ href

QString IR::CatalogEntry::href

Definition at line 17 of file catalogentry.h.

◆ isDeprecated

bool IR::CatalogEntry::isDeprecated { false }

Definition at line 20 of file catalogentry.h.

◆ name

QString IR::CatalogEntry::name

Definition at line 16 of file catalogentry.h.

Referenced by testing.tools.encode_pdf_filter._PdfStream::RegisterByName().

◆ since

QString IR::CatalogEntry::since

Definition at line 19 of file catalogentry.h.

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

qttools/src/qdoc/qdoc/src/qdoc/ir/catalogentry.h (1eea2ad049f885b47b09d9ef04644c7fcea184b4)