diff options
| author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2016-05-31 16:33:29 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2016-06-01 08:02:02 +0000 |
| commit | 224742f0e2e882bce21047622d4c351803b9d486 (patch) | |
| tree | 24f3bb61480c08c037f8197eeed2e07a4f9e6823 /src/webchannel/qqmlwebchannel.cpp | |
| parent | 7774f94b5d5cf8cea863ba22258bbd4543fab5ac (diff) | |
| download | qtwebchannel-224742f0e2e882bce21047622d4c351803b9d486.tar.gz | |
Doc: Fix linking to methods and properties within the type
You don't need the type name for linking within the type docs.
Also, the convention in QML and Qt Quick is to use a period and
not a double colon.
Change-Id: Ic93bae51e766ef782f089ce69dc4e54a712445c6
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
Diffstat (limited to 'src/webchannel/qqmlwebchannel.cpp')
| -rw-r--r-- | src/webchannel/qqmlwebchannel.cpp | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/src/webchannel/qqmlwebchannel.cpp b/src/webchannel/qqmlwebchannel.cpp index c9567a3..4bd4413 100644 --- a/src/webchannel/qqmlwebchannel.cpp +++ b/src/webchannel/qqmlwebchannel.cpp @@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE A list of transport objects, which implement QWebChannelAbstractTransport. The transports are used to talk to the remote clients. - \sa WebChannel::connectTo(), WebChannel::disconnectFrom() + \sa connectTo(), disconnectFrom() */ /*! @@ -71,7 +71,7 @@ QT_BEGIN_NAMESPACE \brief A list of objects which should be accessible to remote clients. - The objects must have the attached WebChannel::id property set to an identifier, under which the + The objects must have the attached \l id property set to an identifier, under which the object is then known on the HTML side. Once registered, all signals and property changes are automatically propagated to the clients. @@ -80,7 +80,7 @@ QT_BEGIN_NAMESPACE If one needs to register objects which are not available when the component is created, use the imperative registerObjects method. - \sa WebChannel::registerObjects(), WebChannel::id + \sa registerObjects(), id */ class QQmlWebChannelPrivate : public QWebChannelPrivate @@ -137,7 +137,7 @@ QQmlWebChannel::~QQmlWebChannel() This imperative API can be used to register objects on the fly. For static objects, the declarative registeredObjects property should be preferred. - \sa WebChannel::registeredObjects + \sa registeredObjects */ void QQmlWebChannel::registerObjects(const QVariantMap &objects) { @@ -166,7 +166,7 @@ QQmlWebChannelAttached *QQmlWebChannel::qmlAttachedProperties(QObject *obj) The transport object must be an implementation of QWebChannelAbstractTransport. - \sa WebChannel::transports, WebChannel::disconnectFrom() + \sa transports, disconnectFrom() */ void QQmlWebChannel::connectTo(QObject *transport) { @@ -185,7 +185,7 @@ void QQmlWebChannel::connectTo(QObject *transport) The client will not be able to communicate with the WebChannel anymore, nor will it receive any signals or property updates. - \sa WebChannel::connectTo() + \sa connectTo() */ void QQmlWebChannel::disconnectFrom(QObject *transport) { |