IR::QmlTypeInfo Struct Reference

#include <document.h>

Collaboration diagram for IR::QmlTypeInfo:

Classes
struct	InheritsInfo
struct	InheritedByEntry
struct	NativeTypeInfo

Public Member Functions
QJsonObject	toJson () const
	\variable IR::Document::typeNoun

Public Attributes
QString	importStatement
bool	isSingleton { false }
bool	isValueType { false }
bool	hasObsoleteMembers { false }
QString	obsoleteMembersUrl
std::optional< InheritsInfo >	inherits
QList< InheritedByEntry >	inheritedBy
std::optional< NativeTypeInfo >	nativeType

Detailed Description

Definition at line 26 of file document.h.

Member Function Documentation

toJson()

QJsonObject IR::QmlTypeInfo::toJson ( ) const

nodiscard

\variable IR::Document::typeNoun

Lowercase description of the page type, used in status sentences. For example, "class", "namespace", or "type".

Present only when a deprecation status sentence applies to the page. Omitted otherwise so pages without a sentence are unaffected.

\variable IR::Document::deprecatedSinceQualified

Qualified version string of the form "module version", used in deprecated status sentences. For QML types this is the QML module name and version, such as "QtQml 6.5". For all other nodes it equals \l deprecatedSince.

Present only when a deprecation status sentence applies and \l deprecatedSince is non-empty. Omitted otherwise so pages without a sentence are unaffected.

Converts the QmlTypeInfo to a QJsonObject for template rendering.

Always emits isSingleton, isValueType, and hasObsoleteMembers. The importStatement, inherits, inheritedBy, and nativeType fields are omitted when they don't have values. The obsoleteMembersUrl field is omitted when empty; templates should use {existsIn()} to guard access to those optional fields.

Definition at line 62 of file document.cpp.

Member Data Documentation

hasObsoleteMembers

bool IR::QmlTypeInfo::hasObsoleteMembers { false }

Definition at line 31 of file document.h.

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

importStatement

QString IR::QmlTypeInfo::importStatement

Definition at line 28 of file document.h.

inheritedBy

QList<InheritedByEntry> IR::QmlTypeInfo::inheritedBy

Definition at line 45 of file document.h.

inherits

std::optional<InheritsInfo> IR::QmlTypeInfo::inherits

Definition at line 39 of file document.h.

isSingleton

bool IR::QmlTypeInfo::isSingleton { false }

Definition at line 29 of file document.h.

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

isValueType

bool IR::QmlTypeInfo::isValueType { false }

Definition at line 30 of file document.h.

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

nativeType

std::optional<NativeTypeInfo> IR::QmlTypeInfo::nativeType

Definition at line 51 of file document.h.

obsoleteMembersUrl

QString IR::QmlTypeInfo::obsoleteMembersUrl

Definition at line 32 of file document.h.

---

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

• qttools/src/qdoc/qdoc/src/qdoc/ir/document.h (d140f2c07e33c5ab7750bb885847dced699bf9cf)
• qttools/src/qdoc/qdoc/src/qdoc/ir/document.cpp (d140f2c07e33c5ab7750bb885847dced699bf9cf)