diff options
author | Andreas Eliasson <andreas.eliasson@qt.io> | 2023-08-24 13:52:40 +0200 |
---|---|---|
committer | Andreas Eliasson <andreas.eliasson@qt.io> | 2023-08-28 07:34:54 +0200 |
commit | 111cfce6c2f22e8c448f83df023cd45bf0c97ff2 (patch) | |
tree | 94873b79252ed40d6626a955906bd5dd015bca05 /src/remoteobjects/qremoteobjectregistry.cpp | |
parent | c4ac9d8e236d2c9b2a4549a3b1e51c3c2197864f (diff) |
Doc: Fix typedef description of QRemoteObjectSourceLocation(s)
The docs indicate that its properties and members are typedefs for
QPair/QHash<QString, QUrl>, when in fact they should be
<QString, QRemoteObjectSourceLocationInfo>
Fixes: QTBUG-115458
Pick-to: 6.6 6.5 6.4 6.2 5.15
Change-Id: Ic79f7f56be2a12a2c3a89ed1a9e1f9c9f23f6eac
Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
Diffstat (limited to 'src/remoteobjects/qremoteobjectregistry.cpp')
-rw-r--r-- | src/remoteobjects/qremoteobjectregistry.cpp | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/src/remoteobjects/qremoteobjectregistry.cpp b/src/remoteobjects/qremoteobjectregistry.cpp index dbfad5a..4e09e27 100644 --- a/src/remoteobjects/qremoteobjectregistry.cpp +++ b/src/remoteobjects/qremoteobjectregistry.cpp @@ -52,7 +52,8 @@ QRemoteObjectRegistry::QRemoteObjectRegistry(QRemoteObjectNode *node, const QStr This signal is emitted whenever a new source location is added to the registry. - \a entry is a QRemoteObjectSourceLocation, a typedef for QPair<QString, QUrl>. + \a entry is a QRemoteObjectSourceLocation, a typedef for + QPair<QString, QRemoteObjectSourceLocationInfo>. \sa remoteObjectRemoved() */ @@ -62,7 +63,8 @@ QRemoteObjectRegistry::QRemoteObjectRegistry(QRemoteObjectNode *node, const QStr This signal is emitted whenever a Source location is removed from the Registry. - \a entry is a QRemoteObjectSourceLocation, a typedef for QPair<QString, QUrl>. + \a entry is a QRemoteObjectSourceLocation, a typedef for + QPair<QString, QRemoteObjectSourceLocationInfo>. \sa remoteObjectAdded() */ @@ -72,8 +74,9 @@ QRemoteObjectRegistry::QRemoteObjectRegistry(QRemoteObjectNode *node, const QStr \brief The set of sources known to the registry. This property is a QRemoteObjectSourceLocations, which is a typedef for - QHash<QString, QUrl>. Each known \l Source is the QString key, while the - url for the host node is the corresponding value for that key in the hash. + QHash<QString, QRemoteObjectSourceLocationInfo>. Each known \l Source is + contained as a QString key in the hash, and the corresponding value for + that key is the QRemoteObjectSourceLocationInfo for the host node. */ /*! |