diff options
author | Alex Blasche <alexander.blasche@theqtcompany.com> | 2016-05-19 13:26:09 +0200 |
---|---|---|
committer | Alex Blasche <alexander.blasche@theqtcompany.com> | 2016-05-19 12:25:14 +0000 |
commit | 424308422fe0b11e636a0fa6f1d7b91b266d3d1e (patch) | |
tree | ce1f32edf6036b62d94427317336019c89a48f64 | |
parent | b274a37aac474b1603f907f643b178941998523c (diff) | |
download | qtconnectivity-424308422fe0b11e636a0fa6f1d7b91b266d3d1e.tar.gz |
Add missing \since 5.7 markers to QLE classes
Change-Id: I60f7c4751cb2b1a298a22d2b6d44c1c07967e47c
Reviewed-by: Christian Kandeler <christian.kandeler@theqtcompany.com>
-rw-r--r-- | src/bluetooth/qlowenergycontroller.cpp | 23 | ||||
-rw-r--r-- | src/bluetooth/qlowenergyservice.cpp | 1 |
2 files changed, 23 insertions, 1 deletions
diff --git a/src/bluetooth/qlowenergycontroller.cpp b/src/bluetooth/qlowenergycontroller.cpp index 7f3995ed..c152ded2 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. */ /*! @@ -255,6 +256,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() */ @@ -550,9 +552,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) @@ -567,7 +571,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) { @@ -811,6 +817,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, @@ -830,6 +839,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() { @@ -845,6 +857,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, @@ -916,6 +930,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) { @@ -945,6 +961,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 { diff --git a/src/bluetooth/qlowenergyservice.cpp b/src/bluetooth/qlowenergyservice.cpp index 1e5c363d..e9722f81 100644 --- a/src/bluetooth/qlowenergyservice.cpp +++ b/src/bluetooth/qlowenergyservice.cpp @@ -229,6 +229,7 @@ QT_BEGIN_NAMESPACE \value LocalService The service is associated with a controller object in the \l{QLowEnergyController::PeripheralRole}{peripheral role}. Such service objects do not change their state. + This value was introduced by Qt 5.7. */ /*! |