diff options
| author | Sze Howe Koh <szehowe.koh@gmail.com> | 2014-03-15 09:27:04 +0800 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-03-18 12:50:07 +0100 |
| commit | dc1d469a2f6e5773dfb3d29227de07fbed7504dd (patch) | |
| tree | 9bf0912504cd45038da26486f70afb486f9b562f /src/imports | |
| parent | 2802eac9bc9ce2c26d09f9598263337287e2765e (diff) | |
Doc: Document signals (not handlers) under \qmlsignal
Append the handler names to the end of the corresponding signal doc.
Task-number: QTBUG-35846
Change-Id: I0d1c067e9eca4c3c28489a074a7f0e33759c000a
Reviewed-by: Alex Blasche <alexander.blasche@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/imports')
| -rw-r--r-- | src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp | 8 | ||||
| -rw-r--r-- | src/imports/bluetooth/qdeclarativebluetoothservice.cpp | 4 |
2 files changed, 9 insertions, 3 deletions
diff --git a/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp b/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp index bec7b717..842d042d 100644 --- a/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp +++ b/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp @@ -270,9 +270,11 @@ QVariant QDeclarativeBluetoothDiscoveryModel::data(const QModelIndex &index, int /*! \qmlsignal BluetoothDiscoveryModel::serviceDiscovered(BluetoothService service) - This handler is called when a new service is discovered. The \a service + This signal is emitted when a new service is discovered. The \a service parameter contains the service details. + The corresponding handler is \c onServiceDiscovered. + \sa BluetoothService */ @@ -301,8 +303,10 @@ void QDeclarativeBluetoothDiscoveryModel::serviceDiscovered(const QBluetoothServ /*! \qmlsignal BluetoothDiscoveryModel::deviceDiscovered(string device) - This handler is called when a new device is discovered. \a device contains + This signal is emitted when a new device is discovered. \a device contains the Bluetooth address of the discovred device. + + The corresponding handler is \c onDeviceDiscovered. */ void QDeclarativeBluetoothDiscoveryModel::deviceDiscovered(const QBluetoothDeviceInfo &device) diff --git a/src/imports/bluetooth/qdeclarativebluetoothservice.cpp b/src/imports/bluetooth/qdeclarativebluetoothservice.cpp index 6d4e3dc0..adff13db 100644 --- a/src/imports/bluetooth/qdeclarativebluetoothservice.cpp +++ b/src/imports/bluetooth/qdeclarativebluetoothservice.cpp @@ -69,7 +69,7 @@ /*! \qmlsignal BluetoothService::detailsChanged() - This handler is called when any of the following properties changes: + This signal is emitted when any of the following properties changes: \list \li deviceAddress @@ -80,6 +80,8 @@ \li serviceProtocol \li serviceUuid \endlist + + The corresponding handler is \c onDetailsChanged. */ Q_DECLARE_LOGGING_CATEGORY(QT_BT_QML) |