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

#include <document.h>

Collaboration diagram for IR::CppReferenceInfo:

Classes

struct  BaseClassEntry
struct  DerivedClassEntry
struct  ComparisonEntry
struct  ThreadSafetyExceptionEntry
struct  ThreadSafetyInfo
struct  GroupEntry

Public Member Functions

QJsonObject toJson () const
 Converts CppReferenceInfo to a QJsonObject for template rendering.

Public Attributes

QString headerInclude
QString cmakeFindPackage
QString cmakeTargetLinkLibraries
QString qmakeVariable
QString statusText
QString statusCssClass
std::optional< QmlNativeTypeLink > qmlNativeType
QList< BaseClassEntry > baseClasses
QList< DerivedClassEntry > derivedClasses
bool suppressInheritance { false }
QList< SignatureSpan > templateDeclSpans
bool isInnerClass { false }
bool isNamespace { false }
bool isHeader { false }
bool isPartialNamespace { false }
QString fullNamespaceHref
QString fullNamespaceModuleName
QString typeWord
QStringList ancestorNames
QString selfComparisonCategory
QList< ComparisonEntry > comparisonEntries
std::optional< ThreadSafetyInfo > threadSafety
QList< ContentBlock > threadSafetyAdmonition
QList< GroupEntry > groups
bool hasObsoleteMembers { false }
QString obsoleteMembersUrl

Detailed Description

Definition at line 82 of file document.h.

Member Function Documentation

◆ toJson()

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

Converts CppReferenceInfo to a QJsonObject for template rendering.

Boolean flags and list fields are always emitted so templates can iterate without guards. String fields are omitted when empty. The access specifier on base class entries uses the {id, label} convention from classificationjson.h.

Definition at line 135 of file document.cpp.

Member Data Documentation

◆ ancestorNames

QStringList IR::CppReferenceInfo::ancestorNames

Definition at line 145 of file document.h.

◆ baseClasses

QList<BaseClassEntry> IR::CppReferenceInfo::baseClasses

Definition at line 130 of file document.h.

◆ cmakeFindPackage

QString IR::CppReferenceInfo::cmakeFindPackage

Definition at line 124 of file document.h.

◆ cmakeTargetLinkLibraries

QString IR::CppReferenceInfo::cmakeTargetLinkLibraries

Definition at line 125 of file document.h.

◆ comparisonEntries

QList<ComparisonEntry> IR::CppReferenceInfo::comparisonEntries

Definition at line 148 of file document.h.

◆ derivedClasses

QList<DerivedClassEntry> IR::CppReferenceInfo::derivedClasses

Definition at line 131 of file document.h.

◆ fullNamespaceHref

QString IR::CppReferenceInfo::fullNamespaceHref

Definition at line 141 of file document.h.

◆ fullNamespaceModuleName

QString IR::CppReferenceInfo::fullNamespaceModuleName

Definition at line 142 of file document.h.

◆ groups

QList<GroupEntry> IR::CppReferenceInfo::groups

Definition at line 153 of file document.h.

◆ hasObsoleteMembers

bool IR::CppReferenceInfo::hasObsoleteMembers { false }

Definition at line 155 of file document.h.

Referenced by IR::Builder::buildPageIR().

◆ headerInclude

QString IR::CppReferenceInfo::headerInclude

Definition at line 123 of file document.h.

◆ isHeader

bool IR::CppReferenceInfo::isHeader { false }

Definition at line 138 of file document.h.

Referenced by IR::Builder::buildPageIR().

◆ isInnerClass

bool IR::CppReferenceInfo::isInnerClass { false }

Definition at line 136 of file document.h.

Referenced by IR::Builder::buildPageIR().

◆ isNamespace

bool IR::CppReferenceInfo::isNamespace { false }

Definition at line 137 of file document.h.

Referenced by IR::Builder::buildPageIR().

◆ isPartialNamespace

bool IR::CppReferenceInfo::isPartialNamespace { false }

Definition at line 140 of file document.h.

Referenced by IR::Builder::buildPageIR().

◆ obsoleteMembersUrl

QString IR::CppReferenceInfo::obsoleteMembersUrl

Definition at line 156 of file document.h.

◆ qmakeVariable

QString IR::CppReferenceInfo::qmakeVariable

Definition at line 126 of file document.h.

◆ qmlNativeType

std::optional<QmlNativeTypeLink> IR::CppReferenceInfo::qmlNativeType

Definition at line 129 of file document.h.

◆ selfComparisonCategory

QString IR::CppReferenceInfo::selfComparisonCategory

Definition at line 147 of file document.h.

◆ statusCssClass

QString IR::CppReferenceInfo::statusCssClass

Definition at line 128 of file document.h.

◆ statusText

QString IR::CppReferenceInfo::statusText

Definition at line 127 of file document.h.

◆ suppressInheritance

bool IR::CppReferenceInfo::suppressInheritance { false }

Definition at line 132 of file document.h.

Referenced by IR::Builder::buildPageIR().

◆ templateDeclSpans

QList<SignatureSpan> IR::CppReferenceInfo::templateDeclSpans

Definition at line 134 of file document.h.

◆ threadSafety

std::optional<ThreadSafetyInfo> IR::CppReferenceInfo::threadSafety

Definition at line 150 of file document.h.

◆ threadSafetyAdmonition

QList<ContentBlock> IR::CppReferenceInfo::threadSafetyAdmonition

Definition at line 151 of file document.h.

◆ typeWord

QString IR::CppReferenceInfo::typeWord

Definition at line 144 of file document.h.

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