diff options
author | Nico Vertriest <nico.vertriest@qt.io> | 2019-03-19 12:48:46 +0100 |
---|---|---|
committer | Nico Vertriest <nico.vertriest@qt.io> | 2019-03-25 05:56:55 +0000 |
commit | 3eb2921cf1c6a48fbd16d5bd0902c5a83c8b0ca8 (patch) | |
tree | 6467d4c15ec93f2452296e1a4bb8be73f782cc84 /src | |
parent | 3809bdf15524e65397447eb7ba62a289c5ef58d4 (diff) | |
download | qtwebchannel-3eb2921cf1c6a48fbd16d5bd0902c5a83c8b0ca8.tar.gz |
Doc: Fix some qdoc errors
- add documentation to parameter \a objects
- correct link to example code
Change-Id: Idedfd749dad01315ee0073ca5a87399b9fa30d70
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Reviewed-by: Milian Wolff <milian.wolff@kdab.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/webchannel/qqmlwebchannel.cpp | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/webchannel/qqmlwebchannel.cpp b/src/webchannel/qqmlwebchannel.cpp index d23ebef..20f6e73 100644 --- a/src/webchannel/qqmlwebchannel.cpp +++ b/src/webchannel/qqmlwebchannel.cpp @@ -134,8 +134,8 @@ QQmlWebChannel::~QQmlWebChannel() /*! \qmlmethod void WebChannel::registerObjects(QVariantMap objects) - Registers objects to make them accessible to HTML clients. The key of the - map is used as an identifier for the object on the client side. + Registers the specified \a objects to make them accessible to HTML clients. + The key of the map is used as an identifier for the object on the client side. Once registered, all signals and property changes are automatically propagated to the clients. Public invokable methods, including slots, are also accessible to the clients. |