diff options
author | Alex Blasche <alexander.blasche@digia.com> | 2014-01-15 15:04:24 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-01-15 21:52:44 +0100 |
commit | ef6de7d737daa42c3390a0393e77044e91df9ae1 (patch) | |
tree | cb1ef74253265a02833347d4cf323d9cddd8bd65 /src | |
parent | 81be87c88f5043a4a6e195461a79a66352c15d58 (diff) |
Document a somewhat peculiar signal behavior mismatch during Bt discovery
Change-Id: I8f9ac85e7753a9d6142bbefcd0e4bcda09e0f3d8
Reviewed-by: Fabian Bumberger <fbumberger@rim.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/bluetooth/qbluetoothdevicediscoveryagent.cpp | 2 | ||||
-rw-r--r-- | src/bluetooth/qbluetoothservicediscoveryagent.cpp | 10 |
2 files changed, 9 insertions, 3 deletions
diff --git a/src/bluetooth/qbluetoothdevicediscoveryagent.cpp b/src/bluetooth/qbluetoothdevicediscoveryagent.cpp index b48a7bc4..7df7bdca 100644 --- a/src/bluetooth/qbluetoothdevicediscoveryagent.cpp +++ b/src/bluetooth/qbluetoothdevicediscoveryagent.cpp @@ -105,12 +105,14 @@ QT_BEGIN_NAMESPACE \fn void QBluetoothDeviceDiscoveryAgent::finished() This signal is emitted when Bluetooth device discovery completes. + The signal is not going to be emitted if the device discovery finishes with an error. */ /*! \fn void QBluetoothDeviceDiscoveryAgent::error(QBluetoothDeviceDiscoveryAgent::Error error) This signal is emitted when an \a error occurs during Bluetooth device discovery. + The \a error parameter describes the error that occurred. \sa error(), errorString() */ diff --git a/src/bluetooth/qbluetoothservicediscoveryagent.cpp b/src/bluetooth/qbluetoothservicediscoveryagent.cpp index eec9894f..6f45136a 100644 --- a/src/bluetooth/qbluetoothservicediscoveryagent.cpp +++ b/src/bluetooth/qbluetoothservicediscoveryagent.cpp @@ -107,14 +107,18 @@ QT_BEGIN_NAMESPACE /*! \fn QBluetoothServiceDiscoveryAgent::finished() - This signal is emitted when Bluetooth service discovery completes. This signal will even - be emitted when an error occurred during the service discovery. + This signal is emitted when the Bluetooth service discovery completes. + + Unlike the \l QBluetoothDeviceDiscoveryAgent::finished() signal this + signal will even be emitted when an error occurred during the service discovery. Therefore + it is recommended to check the \l error() signal to evaluate the success of the + service discovery discovery. */ /*! \fn void QBluetoothServiceDiscoveryAgent::error(QBluetoothServiceDiscoveryAgent::Error error) - This signal is emitted when an error occurs. The \a error parameter describes the error that + This signal is emitted when an \a error occurs. The \a error parameter describes the error that occurred. */ |