diff options
author | Nedim Hadzic <nhadzic@blackberry.com> | 2014-01-14 17:45:29 +0100 |
---|---|---|
committer | Nedim Hadzic <nhadzic@blackberry.com> | 2014-02-13 09:38:17 +0100 |
commit | 9bcb79f0c741f7805dad17c467a5c2041227a18a (patch) | |
tree | e2d302659297c0683621c376a73b522baee07a59 /src | |
parent | 90d6c3a64ab39525ab89f7141ea502c8c238a533 (diff) | |
download | qtconnectivity-9bcb79f0c741f7805dad17c467a5c2041227a18a.tar.gz |
Added class description.
BLE info classes did not have basic description, which is added now.
Change-Id: I5cc679ebe3ad0ae74c558cf0f782a9bf20ed8f21
Reviewed-by: Alex Blasche <alexander.blasche@digia.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/bluetooth/qlowenergycharacteristicinfo.cpp | 13 | ||||
-rw-r--r-- | src/bluetooth/qlowenergydescriptorinfo.cpp | 12 | ||||
-rw-r--r-- | src/bluetooth/qlowenergyserviceinfo.cpp | 15 |
3 files changed, 40 insertions, 0 deletions
diff --git a/src/bluetooth/qlowenergycharacteristicinfo.cpp b/src/bluetooth/qlowenergycharacteristicinfo.cpp index 44a7b58d..128f9f97 100644 --- a/src/bluetooth/qlowenergycharacteristicinfo.cpp +++ b/src/bluetooth/qlowenergycharacteristicinfo.cpp @@ -46,6 +46,19 @@ QT_BEGIN_NAMESPACE /*! + \class QLowEnergyCharacteristicInfo + \inmodule QtBluetooth + \brief The QLowEnergyCharacteristicInfo class stores information about a Bluetooth + Low Energy service characteristic. + + QLowEnergyCharacteristicInfo provides information about a Bluetooth Low Energy + service characteristic's name, UUID, value, permissions, handle and descriptors. + To get the full characteristic specification and information it is necessary to + connect to the service using QLowEnergyServiceInfo and QLowEnergyController classes. + Some characteristics can contain none, one or more descriptors. +*/ + +/*! \enum QLowEnergyCharacteristicInfo::Error This enum describes the type of an error that can appear. diff --git a/src/bluetooth/qlowenergydescriptorinfo.cpp b/src/bluetooth/qlowenergydescriptorinfo.cpp index 92d376a2..9e5e0ba3 100644 --- a/src/bluetooth/qlowenergydescriptorinfo.cpp +++ b/src/bluetooth/qlowenergydescriptorinfo.cpp @@ -44,6 +44,18 @@ QT_BEGIN_NAMESPACE +/*! + \class QLowEnergyDescriptorInfo + \inmodule QtBluetooth + \brief The QLowEnergyDescriptorInfo class stores information about the Bluetooth + Low Energy descriptor. + + QLowEnergyDescriptorInfo provides information about a Bluetooth Low Energy + descriptor's name, UUID, value and handle. Descriptors are contained in the + Bluetooth Low Energy characteristic and they provide additional information + about the characteristic (data format, notification activation, etc). +*/ + QString parseDescriptorUuid(const QBluetoothUuid &uuid) { static QHash<int, QString> uuidnames; diff --git a/src/bluetooth/qlowenergyserviceinfo.cpp b/src/bluetooth/qlowenergyserviceinfo.cpp index 178ca704..618bd9c7 100644 --- a/src/bluetooth/qlowenergyserviceinfo.cpp +++ b/src/bluetooth/qlowenergyserviceinfo.cpp @@ -45,6 +45,21 @@ QT_BEGIN_NAMESPACE /*! + \class QLowEnergyServiceInfo + \inmodule QtBluetooth + \brief The QLowEnergyServiceInfo class stores information about the Bluetooth + Low Energy service. + + QLowEnergyServiceInfo provides information about a Bluetooth Low Energy + service's name, device, UUID, connection status, service type, handle + and characteristics. A Bluetooth Low Energy device can have one or more + low energy services. Each low energy service contains one or more + characteristics. The class is used with the QLowEnergyController + class. It is necessary to connect to the service first in order + to get the all service information and characteristics. +*/ + +/*! \enum QLowEnergyServiceInfo::ServiceType This enum describes the type of the service. One LE device can have one or more primary services. |