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

Intermediate representation of a single documentable member. More...

#include <member.h>

Collaboration diagram for IR::MemberIR:

Public Member Functions

QJsonObject toJson () const
 \variable IR::MemberIR::name Unqualified member name.

Public Attributes

QString name
QString fullName
QString signature
QString href
QString brief
NodeType nodeType { NodeType::NoType }
Access access { Access::Public }
Status status { Status::Active }
QString deprecatedSince
QString typeNoun
QString deprecatedSinceQualified
QList< ParameterIR > parameters
int overloadNumber { 0 }
bool isPrimaryOverload { true }
QList< EnumValueIR > enumValues
bool isStatic { false }
bool isConst { false }
bool isVirtual { false }
bool isSignal { false }
bool isSlot { false }
bool isAttached { false }
bool isDefault { false }
bool isReadOnly { false }
bool isRequired { false }
QString dataType
QString anchorId
QString synopsis
QList< IR::SignatureSpan > signatureSpans
QString since
QString threadSafety
QString comparisonCategory
bool isNoexcept { false }
QString noexceptNote
QList< ContentBlock > body
QList< ContentBlock > alsoList
int sharedGroup { -1 }

Detailed Description

Intermediate representation of a single documentable member.

MemberIR captures identity, classification, and type-specific metadata for one member of an aggregate (such as a class, namespace, or QML type). Function members carry parameter lists and overload metadata; enum members carry value listings. Templates use this to render summary tables and detail sections.

JSON output omits parameters and enumValues when the respective lists are empty. The nodeType field is omitted when set to NoType.

Definition at line 53 of file member.h.

Member Function Documentation

◆ toJson()

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

\variable IR::MemberIR::name Unqualified member name.

\variable IR::MemberIR::fullName Fully qualified name including the enclosing scope.

\variable IR::MemberIR::signature Display signature for synopsis rendering. The format depends on the member type: functions include return type and default values, properties use "name : type", and enums include the scoped or unscoped distinction.

\variable IR::MemberIR::href URL of the member's detailed documentation.

\variable IR::MemberIR::brief One-line summary extracted from the member's doc comment, empty if none.

\variable IR::MemberIR::nodeType Classification of the member's entity type (function, property, enum, and so on). Defaults to NoType.

\variable IR::MemberIR::access Access level (public, protected, or private). Defaults to Public.

\variable IR::MemberIR::status Documentation status (active, deprecated, preliminary, or internal). Defaults to Active.

\variable IR::MemberIR::deprecatedSince Version the member was deprecated in, or the version in which a scheduled deprecation takes place. Empty when no deprecation status sentence applies.

\variable IR::MemberIR::typeNoun Human-readable noun for the member's node type (such as "function", "property", or "method"), used to build the deprecation status sentence. Empty when no status sentence applies.

\variable IR::MemberIR::deprecatedSinceQualified The deprecation version prefixed with the QML module name for QML members that have a logical module name (such as "QtQuick 6.5"); otherwise the plain deprecatedSince. Empty when no status sentence applies or when there is no version.

\variable IR::MemberIR::parameters Parameter list for function members. Empty for non-functions.

\variable IR::MemberIR::overloadNumber Zero-based overload index. Zero indicates the primary overload.

\variable IR::MemberIR::isPrimaryOverload Whether this is the primary (first) overload of its name. Defaults to true.

\variable IR::MemberIR::enumValues Value list for enum members. Empty for non-enums.

\variable IR::MemberIR::signatureSpans Structured signature spans carrying semantic roles and resolved hrefs. When populated, templates can render rich signatures with type links and role-based styling. Empty by default for backward compatibility with the plain text synopsis field.

\variable IR::MemberIR::isStatic Whether the member is declared static.

\variable IR::MemberIR::isConst Whether the member is declared const.

\variable IR::MemberIR::isVirtual Whether the member is virtual (including pure virtual and override).

\variable IR::MemberIR::isSignal Whether the member is a Qt signal.

\variable IR::MemberIR::isSlot Whether the member is a Qt slot.

\variable IR::MemberIR::sharedGroup Index of the section's shared detail group this member belongs to, or -1 when the member carries its own body and see-also content. A member of a shared group has an empty body and alsoList; the shared content is rendered once from the group its index refers to. The sharedGroup key is omitted from JSON when -1.

Converts the member to a QJsonObject for template rendering.

Emits identity fields (name, fullName, signature, href), classification as {id, label} objects, overload metadata, and qualifier flags. The brief, parameters, and enumValues fields are omitted when empty. The nodeType field is omitted when NoType. The sharedGroup field is omitted when -1.

Definition at line 381 of file member.cpp.

Member Data Documentation

◆ access

Access IR::MemberIR::access { Access::Public }

Definition at line 61 of file member.h.

Referenced by NodeExtractor::extractMemberIR().

◆ alsoList

QList<ContentBlock> IR::MemberIR::alsoList

Definition at line 97 of file member.h.

◆ anchorId

QString IR::MemberIR::anchorId

Definition at line 88 of file member.h.

◆ body

QList<ContentBlock> IR::MemberIR::body

Definition at line 96 of file member.h.

◆ brief

QString IR::MemberIR::brief

Definition at line 58 of file member.h.

◆ comparisonCategory

QString IR::MemberIR::comparisonCategory

Definition at line 93 of file member.h.

◆ dataType

QString IR::MemberIR::dataType

Definition at line 85 of file member.h.

◆ deprecatedSince

QString IR::MemberIR::deprecatedSince

Definition at line 64 of file member.h.

◆ deprecatedSinceQualified

QString IR::MemberIR::deprecatedSinceQualified

Definition at line 66 of file member.h.

◆ enumValues

QList<EnumValueIR> IR::MemberIR::enumValues

Definition at line 72 of file member.h.

◆ fullName

QString IR::MemberIR::fullName

Definition at line 55 of file member.h.

◆ href

QString IR::MemberIR::href

Definition at line 57 of file member.h.

◆ isAttached

bool IR::MemberIR::isAttached { false }

Definition at line 81 of file member.h.

Referenced by NodeExtractor::extractMemberIR().

◆ isConst

bool IR::MemberIR::isConst { false }

Definition at line 75 of file member.h.

Referenced by NodeExtractor::extractMemberIR().

◆ isDefault

bool IR::MemberIR::isDefault { false }

Definition at line 82 of file member.h.

Referenced by NodeExtractor::extractMemberIR().

◆ isNoexcept

bool IR::MemberIR::isNoexcept { false }

Definition at line 94 of file member.h.

Referenced by NodeExtractor::extractMemberIR().

◆ isPrimaryOverload

bool IR::MemberIR::isPrimaryOverload { true }

Definition at line 70 of file member.h.

Referenced by NodeExtractor::extractMemberIR().

◆ isReadOnly

bool IR::MemberIR::isReadOnly { false }

Definition at line 83 of file member.h.

Referenced by NodeExtractor::extractMemberIR().

◆ isRequired

bool IR::MemberIR::isRequired { false }

Definition at line 84 of file member.h.

Referenced by NodeExtractor::extractMemberIR().

◆ isSignal

bool IR::MemberIR::isSignal { false }

Definition at line 77 of file member.h.

Referenced by NodeExtractor::extractMemberIR().

◆ isSlot

bool IR::MemberIR::isSlot { false }

Definition at line 78 of file member.h.

Referenced by NodeExtractor::extractMemberIR().

◆ isStatic

bool IR::MemberIR::isStatic { false }

Definition at line 74 of file member.h.

Referenced by NodeExtractor::extractMemberIR().

◆ isVirtual

bool IR::MemberIR::isVirtual { false }

Definition at line 76 of file member.h.

Referenced by NodeExtractor::extractMemberIR().

◆ name

QString IR::MemberIR::name

Definition at line 54 of file member.h.

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

◆ nodeType

NodeType IR::MemberIR::nodeType { NodeType::NoType }

Definition at line 60 of file member.h.

Referenced by NodeExtractor::extractMemberIR().

◆ noexceptNote

QString IR::MemberIR::noexceptNote

Definition at line 95 of file member.h.

◆ overloadNumber

int IR::MemberIR::overloadNumber { 0 }

Definition at line 69 of file member.h.

Referenced by NodeExtractor::extractMemberIR().

◆ parameters

QList<ParameterIR> IR::MemberIR::parameters

Definition at line 68 of file member.h.

◆ sharedGroup

int IR::MemberIR::sharedGroup { -1 }

Definition at line 101 of file member.h.

◆ signature

QString IR::MemberIR::signature

Definition at line 56 of file member.h.

◆ signatureSpans

QList<IR::SignatureSpan> IR::MemberIR::signatureSpans

Definition at line 90 of file member.h.

◆ since

QString IR::MemberIR::since

Definition at line 91 of file member.h.

◆ status

Status IR::MemberIR::status { Status::Active }

Definition at line 62 of file member.h.

Referenced by NodeExtractor::extractMemberIR().

◆ synopsis

QString IR::MemberIR::synopsis

Definition at line 89 of file member.h.

◆ threadSafety

QString IR::MemberIR::threadSafety

Definition at line 92 of file member.h.

◆ typeNoun

QString IR::MemberIR::typeNoun

Definition at line 65 of file member.h.

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