IR::SectionIR Struct Reference

Intermediate representation of a member summary section. More...

#include <member.h>

Collaboration diagram for IR::SectionIR:

Public Member Functions
QJsonObject	toJson () const
	\variable IR::SectionIR::id Stable ASCII identifier for anchor links, generated from the title via TextUtils::asAsciiPrintable().

Public Attributes
QString	id
QString	title
QString	singular
QString	plural
QList< MemberIR >	members
QList< MemberIR >	reimplementedMembers
QList< InheritedMembersIR >	inheritedMembers
QList< SharedDetailGroup >	sharedGroups

Detailed Description

Intermediate representation of a member summary section.

SectionIR groups members by category (such as "Public Functions" or "Properties") for summary table rendering. Each section carries a title, singular and plural forms for inherited-member links, and three member lists: primary members, reimplemented members, and inherited member summaries.

The sharedGroups list carries the shared detail content of member groups documented by a single shared comment; each group's members stay in the flat members list and reference their group through sharedGroup. The reimplementedMembers, inheritedMembers, and sharedGroups arrays are omitted from JSON when empty.

Definition at line 113 of file member.h.

Member Function Documentation

toJson()

QJsonObject IR::SectionIR::toJson ( ) const

nodiscard

\variable IR::SectionIR::id Stable ASCII identifier for anchor links, generated from the title via TextUtils::asAsciiPrintable().

\variable IR::SectionIR::title Display title (such as "Public Functions" or "Properties").

\variable IR::SectionIR::singular Singular form of the member type (such as "function").

\variable IR::SectionIR::plural Plural form of the member type (such as "functions").

\variable IR::SectionIR::members Primary members in this section.

\variable IR::SectionIR::reimplementedMembers Members that reimplement a virtual function from a base class.

\variable IR::SectionIR::inheritedMembers Summaries of members inherited from base classes.

\variable IR::SectionIR::sharedGroups Shared detail groups whose members appear in this section's members list, in the order the groups are encountered. Empty (and omitted from JSON) when the section has no shared comment groups.

Converts the section to a QJsonObject for template rendering.

Emits id, title, singular, plural, and the members array. The reimplementedMembers, inheritedMembers, and sharedGroups arrays are omitted when empty.

Definition at line 586 of file member.cpp.

Member Data Documentation

id

QString IR::SectionIR::id

Definition at line 114 of file member.h.

inheritedMembers

QList<InheritedMembersIR> IR::SectionIR::inheritedMembers

Definition at line 120 of file member.h.

members

QList<MemberIR> IR::SectionIR::members

Definition at line 118 of file member.h.

plural

QString IR::SectionIR::plural

Definition at line 117 of file member.h.

reimplementedMembers

QList<MemberIR> IR::SectionIR::reimplementedMembers

Definition at line 119 of file member.h.

sharedGroups

QList<SharedDetailGroup> IR::SectionIR::sharedGroups

Definition at line 123 of file member.h.

singular

QString IR::SectionIR::singular

Definition at line 116 of file member.h.

title

QString IR::SectionIR::title

Definition at line 115 of file member.h.

---

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

• qttools/src/qdoc/qdoc/src/qdoc/ir/member.h (e803e960fe69d18e26f9481ae40861a47719a008)
• qttools/src/qdoc/qdoc/src/qdoc/ir/member.cpp (e803e960fe69d18e26f9481ae40861a47719a008)