summaryrefslogtreecommitdiffstats
path: root/src/bluetooth/qlowenergyservice.cpp
diff options
context:
space:
mode:
authorIvan Solovev <ivan.solovev@qt.io>2022-05-16 11:42:24 +0200
committerIvan Solovev <ivan.solovev@qt.io>2022-05-19 09:54:00 +0200
commit02ccd2460c7ba2f27e8a2021b1f911a9e16bf703 (patch)
treeb0c133157db89a499d3a630982708e336691c5c8 /src/bluetooth/qlowenergyservice.cpp
parentd58d134d25695dd044fc13d57a4d754b1dfb4e4a (diff)
Properly use 'since' qdoc command in enum values documentation
Instead of manually writing something like "this value was introduced by <Qt version>" Change-Id: I64ab419d034c2b01217670d0a09c9cd9ae79b6df Reviewed-by: Juha Vuolle <juha.vuolle@insta.fi>
Diffstat (limited to 'src/bluetooth/qlowenergyservice.cpp')
-rw-r--r--src/bluetooth/qlowenergyservice.cpp39
1 files changed, 18 insertions, 21 deletions
diff --git a/src/bluetooth/qlowenergyservice.cpp b/src/bluetooth/qlowenergyservice.cpp
index 2b4349b0..859a3a9a 100644
--- a/src/bluetooth/qlowenergyservice.cpp
+++ b/src/bluetooth/qlowenergyservice.cpp
@@ -204,20 +204,19 @@ QT_IMPL_METATYPE_EXTERN_TAGGED(QLowEnergyService::WriteMode, QLowEnergyService__
the service while it was not yet in the
\l ServiceDiscovered \l state() or the service is invalid
due to a loss of connection to the peripheral device.
- \value CharacteristicReadError An attempt to read a characteristic value failed. For example,
- it might be triggered in response to a call to
- \l readCharacteristic(). This value was introduced by Qt 5.5.
+ \value [since 5.5] CharacteristicReadError An attempt to read a characteristic value failed.
+ For example, it might be triggered in response
+ to a call to \l readCharacteristic().
\value CharacteristicWriteError An attempt to write a new value to a characteristic
failed. For example, it might be triggered when attempting
to write to a read-only characteristic.
- \value DescriptorReadError An attempt to read a descriptor value failed. For example,
- it might be triggered in response to a call to
- \l readDescriptor(). This value was introduced by Qt 5.5.
+ \value [since 5.5] DescriptorReadError An attempt to read a descriptor value failed.
+ For example, it might be triggered in response
+ to a call to \l readDescriptor().
\value DescriptorWriteError An attempt to write a new value to a descriptor
failed. For example, it might be triggered when attempting
to write to a read-only descriptor.
- \value UnknownError An unknown error occurred when interacting with the service.
- This value was introduced by Qt 5.5.
+ \value [since 5.5] UnknownError An unknown error occurred when interacting with the service.
*/
/*!
@@ -236,10 +235,9 @@ QT_IMPL_METATYPE_EXTERN_TAGGED(QLowEnergyService::WriteMode, QLowEnergyService__
\l serviceUuid() and \l serviceName().
\value RemoteServiceDiscovering The service details are being discovered.
\value RemoteServiceDiscovered The service details have been discovered.
- \value LocalService The service is associated with a controller object in the
+ \value [since 5.7] 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.
\value DiscoveryRequired Deprecated. Was renamed to RemoteService.
\value DiscoveringService Deprecated. Was renamed to RemoteServiceDiscovering.
\value ServiceDiscovered Deprecated. Was renamed to RemoteServiceDiscovered.
@@ -289,17 +287,16 @@ QT_IMPL_METATYPE_EXTERN_TAGGED(QLowEnergyService::WriteMode, QLowEnergyService__
write operation as it may happen in between other
device interactions.
- \value WriteSigned If a characteristic is written using this mode, the remote peripheral
- shall not send a write confirmation. The operation's success
- cannot be determined and the payload must not be longer than 8 bytes.
- A bond must exist between the two devices and the link must not be
- encrypted.
- A characteristic must have set the
- \l QLowEnergyCharacteristic::WriteSigned property to support this
- write mode.
- This value was introduced in Qt 5.7 and is currently only
- supported on Android and on Linux with BlueZ 5 and a kernel version
- 3.7 or newer.
+ \value [since 5.7] WriteSigned If a characteristic is written using this mode, the remote
+ peripheral shall not send a write confirmation. The operation's
+ success cannot be determined and the payload must not be longer
+ than 8 bytes. A bond must exist between the two devices and the
+ link must not be encrypted.
+ A characteristic must have set the
+ \l QLowEnergyCharacteristic::WriteSigned property to support
+ this write mode.
+ This value is currently only supported on Android and on Linux
+ with BlueZ 5 and a kernel version 3.7 or newer.
*/
/*!