summaryrefslogtreecommitdiff
path: root/src/webchannel/qqmlwebchannelattached.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/webchannel/qqmlwebchannelattached.cpp')
-rw-r--r--src/webchannel/qqmlwebchannelattached.cpp9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/webchannel/qqmlwebchannelattached.cpp b/src/webchannel/qqmlwebchannelattached.cpp
index cfe03f8..257c6a9 100644
--- a/src/webchannel/qqmlwebchannelattached.cpp
+++ b/src/webchannel/qqmlwebchannelattached.cpp
@@ -54,6 +54,15 @@ QQmlWebChannelAttached::~QQmlWebChannelAttached()
}
+/*!
+ \qmlattachedproperty QString WebChannel::id
+
+ \brief The identifier under which an object, registered to a WebChannel, is known to remote clients.
+
+ This property must be set for every object that should be published over the WebChannel.
+ While no restrictions are enforced on the format of the id, it is usually a good idea to
+ choose a string that is also a valid JavaScript identifier.
+*/
QString QQmlWebChannelAttached::id() const
{
return m_id;