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::AllMembersIR Struct Reference

Intermediate representation of the all-members listing page. More...

#include <member.h>

Collaboration diagram for IR::AllMembersIR:

Public Member Functions

QJsonObject toJson () const
 Converts the all-members IR to a QJsonObject for template rendering.

Public Attributes

QString typeName
QString typeHref
bool isQmlType { false }
QList< AllMemberEntrymembers
QList< MemberGroupmemberGroups

Detailed Description

Intermediate representation of the all-members listing page.

AllMembersIR captures all data needed to render a member listing sub-page. It supports two rendering paths: a flat alphabetical list for C++ classes and a grouped-by-origin-type list for QML types. The isQmlType flag determines which path the template uses.

Definition at line 112 of file member.h.

Member Function Documentation

◆ toJson()

QJsonObject IR::AllMembersIR::toJson ( ) const
nodiscard

Converts the all-members IR to a QJsonObject for template rendering.

Always emits typeName, typeHref, and isQmlType. The members and memberGroups arrays are emitted only when non-empty, letting templates distinguish C++ from QML by checking which key exists.

Definition at line 522 of file member.cpp.

Member Data Documentation

◆ isQmlType

bool IR::AllMembersIR::isQmlType { false }

◆ memberGroups

QList<MemberGroup> IR::AllMembersIR::memberGroups

Definition at line 117 of file member.h.

◆ members

QList<AllMemberEntry> IR::AllMembersIR::members

Definition at line 116 of file member.h.

◆ typeHref

QString IR::AllMembersIR::typeHref

Definition at line 114 of file member.h.

◆ typeName

QString IR::AllMembersIR::typeName

Definition at line 113 of file member.h.


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