diff options
author | Alex Blasche <alexander.blasche@theqtcompany.com> | 2016-07-12 07:57:09 +0200 |
---|---|---|
committer | Alex Blasche <alexander.blasche@theqtcompany.com> | 2016-07-12 08:07:34 +0200 |
commit | 60e6d4946b50bfa1d0916bdd3780b3c756a2bd6f (patch) | |
tree | bb4d88b83b392de143d25cef3c9fe8dd90f35cbe /src/bluetooth/qlowenergycontroller.cpp | |
parent | 0c028edf23de0073ba14115b43488a928c6fa492 (diff) | |
parent | d20e2e84ec2edd770c830fe2c399b4c76321d187 (diff) |
Merge remote-tracking branch 'gerrit/5.7' into dev
Change-Id: Id86ae2d8b9f8ebd2a37e8e5fc279916bc92d9982
Diffstat (limited to 'src/bluetooth/qlowenergycontroller.cpp')
-rw-r--r-- | src/bluetooth/qlowenergycontroller.cpp | 23 |
1 files changed, 22 insertions, 1 deletions
diff --git a/src/bluetooth/qlowenergycontroller.cpp b/src/bluetooth/qlowenergycontroller.cpp index eeff4ab0..c6cac44b 100644 --- a/src/bluetooth/qlowenergycontroller.cpp +++ b/src/bluetooth/qlowenergycontroller.cpp @@ -154,6 +154,7 @@ Q_DECLARE_LOGGING_CATEGORY(QT_BT) remote device. \value ClosingState The controller is about to be disconnected from the remote device. \value AdvertisingState The controller is currently advertising data. + This value was introduced by Qt 5.7. */ /*! @@ -259,6 +260,7 @@ Q_DECLARE_LOGGING_CATEGORY(QT_BT) the other side of the connection requested new parameters. The new values can be retrieved from \a newParameters. + \since 5.7 \sa requestConnectionUpdate() */ @@ -554,9 +556,11 @@ QLowEnergyController::QLowEnergyController( Returns a new object of this class that is in the \l CentralRole and has the parent object \a parent. The \a remoteDevice refers to the device that a connection will be established to later. - * + The controller uses the local default Bluetooth adapter for the connection management. + \sa QLowEnergyController::CentralRole + \since 5.7 */ QLowEnergyController *QLowEnergyController::createCentral(const QBluetoothDeviceInfo &remoteDevice, QObject *parent) @@ -571,7 +575,9 @@ QLowEnergyController *QLowEnergyController::createCentral(const QBluetoothDevice Typically, the next step is to call \l startAdvertising() on the returned object. The controller uses the local default Bluetooth adapter for the connection management. + \sa QLowEnergyController::PeripheralRole + \since 5.7 */ QLowEnergyController *QLowEnergyController::createPeripheral(QObject *parent) { @@ -815,6 +821,9 @@ QLowEnergyService *QLowEnergyController::createServiceObject( If this object is currently not in the \l UnconnectedState, nothing happens. \note Advertising will stop automatically once a client connects to the local device. + + \since 5.7 + \sa stopAdvertising() */ void QLowEnergyController::startAdvertising(const QLowEnergyAdvertisingParameters ¶meters, const QLowEnergyAdvertisingData &advertisingData, @@ -834,6 +843,9 @@ void QLowEnergyController::startAdvertising(const QLowEnergyAdvertisingParameter /*! Stops advertising, if this object is currently in the advertising state. + + \since 5.7 + \sa startAdvertising() */ void QLowEnergyController::stopAdvertising() { @@ -849,6 +861,8 @@ void QLowEnergyController::stopAdvertising() Constructs and returns a \l QLowEnergyService object with \a parent from \a service. The controller must be in the \l PeripheralRole and in the \l UnconnectedState. The \a service object must be valid. + + \since 5.7 \sa QLowEnergyServiceData::addIncludedService */ QLowEnergyService *QLowEnergyController::addService(const QLowEnergyServiceData &service, @@ -920,6 +934,8 @@ QLowEnergyService *QLowEnergyController::addService(const QLowEnergyServiceData with the actual new parameters. See the \l QLowEnergyConnectionParameters class for more information on connection parameters. \note Currently, this functionality is only implemented on Linux. + + \since 5.7 */ void QLowEnergyController::requestConnectionUpdate(const QLowEnergyConnectionParameters ¶meters) { @@ -949,6 +965,11 @@ QString QLowEnergyController::errorString() const /*! Returns the role that this controller object is in. + + The role is determined when constructing a QLowEnergyController instance + using \l createCentral() or \l createPeripheral(). + + \since 5.7 */ QLowEnergyController::Role QLowEnergyController::role() const { |