diff options
| author | Timur Pocheptsov <Timur.Pocheptsov@digia.com> | 2015-02-06 11:00:20 +0100 |
|---|---|---|
| committer | Timur Pocheptsov <Timur.Pocheptsov@digia.com> | 2015-02-06 10:14:20 +0000 |
| commit | 87d2660b0878ad08521ad10f364fbe9c3c59f7af (patch) | |
| tree | 0fd6b9f6599c9d460fb46e3df41c1cb19be1ddd5 /src | |
| parent | 9ef4f53f1ff0696d5aae4496715975a2fc884c9b (diff) | |
Qt Bluetooth - update documentation
Add notes about handles on OS X and iOS and their meaning(less).
Change-Id: I61fda1de27d194bd904b88536c180a2acf376690
Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
Diffstat (limited to 'src')
| -rw-r--r-- | src/bluetooth/qlowenergycharacteristic.cpp | 6 | ||||
| -rw-r--r-- | src/bluetooth/qlowenergydescriptor.cpp | 3 |
2 files changed, 9 insertions, 0 deletions
diff --git a/src/bluetooth/qlowenergycharacteristic.cpp b/src/bluetooth/qlowenergycharacteristic.cpp index 91e9d94d..f764eace 100644 --- a/src/bluetooth/qlowenergycharacteristic.cpp +++ b/src/bluetooth/qlowenergycharacteristic.cpp @@ -214,6 +214,9 @@ QByteArray QLowEnergyCharacteristic::value() const Returns the handle of the characteristic's value attribute; or \c 0 if the handle cannot be accessed on the platform or if the characteristic is invalid. + + \note On OS X and iOS handles can differ from 0, but these + values have no special meaning outside of internal/private API. */ QLowEnergyHandle QLowEnergyCharacteristic::handle() const { @@ -314,6 +317,9 @@ bool QLowEnergyCharacteristic::isValid() const \c 0 if the handle cannot be accessed on the platform or if the characteristic is invalid. + \note On OS X and iOS handles can differ from 0, but these + values have no special meaning outside of internal/private API. + \sa isValid() */ QLowEnergyHandle QLowEnergyCharacteristic::attributeHandle() const diff --git a/src/bluetooth/qlowenergydescriptor.cpp b/src/bluetooth/qlowenergydescriptor.cpp index 9c25baa4..e18a4f6b 100644 --- a/src/bluetooth/qlowenergydescriptor.cpp +++ b/src/bluetooth/qlowenergydescriptor.cpp @@ -222,6 +222,9 @@ QBluetoothUuid QLowEnergyDescriptor::uuid() const /*! Returns the handle of the descriptor or \c 0 if the handle cannot be accessed on the platform or the descriptor is invalid. + + \note On OS X and iOS handles can differ from 0, but these + values have no special meaning outside of internal/private API. */ QLowEnergyHandle QLowEnergyDescriptor::handle() const { |