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>

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;