diff options
author | Milian Wolff <milian.wolff@kdab.com> | 2014-07-16 17:39:31 +0200 |
---|---|---|
committer | Sumedha Widyadharma <sumedha.widyadharma@basyskom.com> | 2014-08-01 09:16:16 +0200 |
commit | b84e46090b5230d7ebcdbdabd8c03a9ae5d2f860 (patch) | |
tree | 9687c3b47f4e77e931916a8afe1d516d3b280101 /src/webchannel/qqmlwebchannelattached.cpp | |
parent | 5051411b92b4aca4ed5ec462e7b0e52af4d3951e (diff) | |
download | qtwebchannel-b84e46090b5230d7ebcdbdabd8c03a9ae5d2f860.tar.gz |
Add documentation for the QtWebChannel module.
Please proof-read it and tell me what needs to be improved. I assume
most people will probably not use the QWebChannel directly. Rather, they
will only consume its features indirectly through the integration in
QtWebKit/QtWebEngine. Thus the documentation here is for QWebChannel as
a library. User-end documentation should be added to QtWebKit, I think.
Change-Id: I259c204e24331271b8dc74ea11695988234a79d3
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/webchannel/qqmlwebchannelattached.cpp')
-rw-r--r-- | src/webchannel/qqmlwebchannelattached.cpp | 9 |
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; |