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, 0 insertions, 19 deletions

diff --git a/src/webchannel/qwebchannel.h b/src/webchannel/qwebchannel.h
index 46d77a3..7701751 100644
--- a/src/webchannel/qwebchannel.h
+++ b/src/webchannel/qwebchannel.h
@@ -62,32 +62,13 @@ public:
     explicit QWebChannel(QObject *parent = 0);
     ~QWebChannel();
 
-    /**
-     * Register a map of string ID to QObject* objects.
-     *
-     * The properties, signals and public methods of the QObject are
-     * published to the remote client, where an object with the given identifier
-     * is constructed.
-     *
-     * TODO: This must be called, before clients are initialized.
-     */
     void registerObjects(const QHash<QString, QObject*> &objects);
     QHash<QString, QObject*> registeredObjects() const;
     Q_INVOKABLE void registerObject(const QString &id, QObject *object);
     Q_INVOKABLE void deregisterObject(QObject *object);
 
-    /**
-     * @return true when property updates are blocked, false otherwise.
-     */
     bool blockUpdates() const;
 
-    /**
-     * Set whether property updates should be blocked or not.
-     *
-     * When they are blocked, the remote clients will not be notified about
-     * property changes. The changes are recorded and sent to the clients once
-     * setBlockUpdates(false) is called.
-     */
     void setBlockUpdates(bool block);
 
 Q_SIGNALS: