diff options
| author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2021-08-18 12:49:31 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-08-23 08:27:49 +0000 |
| commit | e96c29c0040f856819255c7ceb81018926350a31 (patch) | |
| tree | 2988523e844c69f8ec3aa549f19e5dccd72cd026 | |
| parent | d511b60d9313b4d08c7b04e39909e0e0415bad07 (diff) | |
Doc: Fix qdoc warnings
qt5/qtconnectivity/src/bluetooth/qlowenergydescriptor.cpp:47: (qdoc) warning: Can't link to 'handle()'
qt5/qtconnectivity/src/bluetooth/qlowenergycharacteristic.cpp:46: (qdoc) warning: Can't link to 'handle()'
Also, dropped unnecessary \l commands against potential auto-links.
Task-number: QTBUG-95860
Change-Id: I3b0286703b65365fef202438d21e4eca446a1c2f
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
(cherry picked from commit 72a11fd0a35e9048d1646c93ae0a4795018a58e0)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | src/bluetooth/qlowenergycharacteristic.cpp | 8 | ||||
| -rw-r--r-- | src/bluetooth/qlowenergydescriptor.cpp | 6 |
2 files changed, 7 insertions, 7 deletions
diff --git a/src/bluetooth/qlowenergycharacteristic.cpp b/src/bluetooth/qlowenergycharacteristic.cpp index c4d00b69..fd0a4fdf 100644 --- a/src/bluetooth/qlowenergycharacteristic.cpp +++ b/src/bluetooth/qlowenergycharacteristic.cpp @@ -52,16 +52,16 @@ QT_BEGIN_NAMESPACE \since 5.4 QLowEnergyCharacteristic provides information about a Bluetooth Low Energy - service characteristic's \l name(), \l uuid(), \l value(), \l properties(), - \l handle() and \l descriptors(). To obtain the characteristic's specification + service characteristic's name(), uuid(), value(), properties(), and + descriptors(). To obtain the characteristic's specification and information, it is necessary to connect to the device using the - \l QLowEnergyService and \l QLowEnergyController classes. + QLowEnergyService and QLowEnergyController classes. The characteristic value may be written via the \l QLowEnergyService instance that manages the service to which this characteristic belongs. The \l {QLowEnergyService::writeCharacteristic()} function writes the new value. The \l {QLowEnergyService::characteristicWritten()} signal is emitted upon success. - The \l value() of this object is automatically updated accordingly. + The value() of this object is automatically updated accordingly. Characteristics may contain none, one or more descriptors. They can be individually retrieved using the \l descriptor() function. The \l descriptors() function returns diff --git a/src/bluetooth/qlowenergydescriptor.cpp b/src/bluetooth/qlowenergydescriptor.cpp index 67a4553c..8b778d19 100644 --- a/src/bluetooth/qlowenergydescriptor.cpp +++ b/src/bluetooth/qlowenergydescriptor.cpp @@ -52,16 +52,16 @@ QT_BEGIN_NAMESPACE \since 5.4 QLowEnergyDescriptor provides information about a Bluetooth Low Energy - descriptor's \l name(), \l uuid(), \l value() and \l handle(). Descriptors are + descriptor's name(), uuid(), and value(). Descriptors are encapsulated by Bluetooth Low Energy characteristics and provide additional contextual information about the characteristic (data format, notification activation and so on). - The descriptor value may be written via the \l QLowEnergyService instance + The descriptor value may be written via the QLowEnergyService instance that manages the service to which this descriptor belongs. The \l {QLowEnergyService::writeDescriptor()} function writes the new value. The \l {QLowEnergyService::descriptorWritten()} signal - is emitted upon success. The cached \l value() of this object is updated accordingly. + is emitted upon success. The cached value() of this object is updated accordingly. \sa QLowEnergyService, QLowEnergyCharacteristic */ |