summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Brasser <mbrasser@ford.com>2020-03-10 08:11:44 -0500
committerMichael Brasser <mbrasser@ford.com>2020-03-10 08:44:41 -0500
commit15e437e870279937b15674c32783c776512ca20d (patch)
tree8343b8654803ebe9f1669e0f1db8ec590203bb40
parent062075e1463b46ea4db76669f052d10ccfa2a0c9 (diff)
Improve enableRemoting/disableRemoting documentationv5.15.0-beta2
Task-number: QTBUG-82462 Change-Id: I922bdbd33dff1b7bca68576b10feb5a28d0516cd Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
-rw-r--r--src/remoteobjects/qremoteobjectnode.cpp8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/remoteobjects/qremoteobjectnode.cpp b/src/remoteobjects/qremoteobjectnode.cpp
index 79d5b23..ffae4de 100644
--- a/src/remoteobjects/qremoteobjectnode.cpp
+++ b/src/remoteobjects/qremoteobjectnode.cpp
@@ -2194,12 +2194,12 @@ QRemoteObjectDynamicReplica *QRemoteObjectNode::acquireDynamic(const QString &na
}
/*!
- \qmlmethod void Host::enableRemoting(object object, string name)
+ \qmlmethod bool Host::enableRemoting(object object, string name)
Enables a host node to dynamically provide remote access to the QObject \a
object. Client nodes connected to the node hosting this object may obtain
Replicas of this Source.
- The \a name defines the lookup-name under which the QObject can be acquired
+ The optional \a name defines the lookup-name under which the QObject can be acquired
using \l QRemoteObjectNode::acquire() . If not explicitly set then the name
given in the QCLASSINFO_REMOTEOBJECT_TYPE will be used. If no such macro
was defined for the QObject then the \l QObject::objectName() is used.
@@ -2216,7 +2216,7 @@ QRemoteObjectDynamicReplica *QRemoteObjectNode::acquireDynamic(const QString &na
object. Client nodes connected to the node
hosting this object may obtain Replicas of this Source.
- The \a name defines the lookup-name under which the QObject can be acquired
+ The optional \a name defines the lookup-name under which the QObject can be acquired
using \l QRemoteObjectNode::acquire() . If not explicitly set then the name
given in the QCLASSINFO_REMOTEOBJECT_TYPE will be used. If no such macro
was defined for the QObject then the \l QObject::objectName() is used.
@@ -2333,7 +2333,7 @@ bool QRemoteObjectHostBase::enableRemoting(QObject *object, const SourceApiMap *
}
/*!
- \qmlmethod void Host::disableRemoting(object remoteObject)
+ \qmlmethod bool Host::disableRemoting(object remoteObject)
Disables remote access for the QObject \a remoteObject. Returns \c false if
the current node is a client node or if the \a remoteObject is not
registered, and returns \c true if remoting is successfully disabled for