diff options
author | Kai Köhne <kai.koehne@qt.io> | 2024-01-04 15:34:08 +0100 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2024-01-10 02:47:04 +0000 |
commit | 6a4bf076c7e3d80bad8fc52de79aeb5b6f85fafa (patch) | |
tree | fae1c14a1ff2e24532fe0b8d1fdd1ba629635be5 | |
parent | e4c255a2bd3a45aa38e52dc9be614081ef54cd39 (diff) |
Doc: Tweak Qt Bluetooth example documentation
Linkify Qt Bluetooth, and add tags.
QtBluetooth will create a link to https://doc.qt.io/qt-6/qtbluetooth-module.html
Change-Id: I9da8bda1591fae26fbe0bde7ac86371af4b9e71c
Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
(cherry picked from commit 619c20be1274778ff3a9344cd7f5b13f085bc956)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
(cherry picked from commit 7d458f96c45474ee20ca3c2f7aaf91a07427aeee)
3 files changed, 10 insertions, 6 deletions
diff --git a/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc b/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc index a986896a..891ffc69 100644 --- a/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc +++ b/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc @@ -5,11 +5,12 @@ \example heartrate-game \title Bluetooth Low Energy Heart Rate Game \examplecategory {Connectivity} + \meta tags {bluetooth, ble, quick} \brief A game demonstrating the interaction with a Bluetooth Low Energy Heart Rate device/service. The Bluetooth Low Energy Heart Rate Game shows how to develop a Bluetooth Low Energy - application using the Qt Bluetooth API. The application covers the scanning for + application using the \l{QtBluetooth}{Qt Bluetooth API}. The application covers the scanning for Bluetooth Low Energy devices, connecting to a Heart Rate service on the device, writing characteristics and descriptors, and receiving updates from the device once the heart rate has changed. @@ -36,7 +37,7 @@ The goal of the game is to increase the measured heart rate as much as possible. A detailed explanation of the APIs used in this example is given in the - \l {Using Qt Bluetooth Low Energy API} section of the Qt Bluetooth module + \l {Using Qt Bluetooth Low Energy API} section of the \l{Qt Bluetooth} module documentation. The \l {lowenergyscanner}{Bluetooth Low Energy Scanner} example might be more suitable diff --git a/examples/bluetooth/heartrate-server/doc/src/heartrate-server.qdoc b/examples/bluetooth/heartrate-server/doc/src/heartrate-server.qdoc index e3e625aa..fa8d57a2 100644 --- a/examples/bluetooth/heartrate-server/doc/src/heartrate-server.qdoc +++ b/examples/bluetooth/heartrate-server/doc/src/heartrate-server.qdoc @@ -5,12 +5,14 @@ \example heartrate-server \title Bluetooth Low Energy Heart Rate Server \examplecategory {Connectivity} + \meta tags {bluetooth, ble} + \brief An example demonstrating how to set up and advertise a GATT service. The example - demonstrates the use of the Qt Bluetooth Low Energy classes related to peripheral (slave) + demonstrates the use of the \l{Qt Bluetooth} Low Energy classes related to peripheral (slave) functionality. The Bluetooth Low Energy Heart Rate Server is a command-line application that shows how to - develop a Bluetooth GATT server using the Qt Bluetooth API. + develop a Bluetooth GATT server using the \l{QtBluetooth}{Qt Bluetooth API}. The application covers setting up a service, advertising it and notifying clients about changes to characteristic values. diff --git a/examples/bluetooth/lowenergyscanner/doc/src/lowenergyscanner.qdoc b/examples/bluetooth/lowenergyscanner/doc/src/lowenergyscanner.qdoc index d7f76c4d..da44fcce 100644 --- a/examples/bluetooth/lowenergyscanner/doc/src/lowenergyscanner.qdoc +++ b/examples/bluetooth/lowenergyscanner/doc/src/lowenergyscanner.qdoc @@ -6,12 +6,13 @@ \example lowenergyscanner \title Bluetooth Low Energy Scanner \examplecategory {Connectivity} + \meta tags {bluetooth, ble} \brief An application designed to browse the content of Bluetooth Low - Energy peripheral devices. The example demonstrates the use of all Qt Bluetooth + Energy peripheral devices. The example demonstrates the use of all \l{Qt Bluetooth} Low Energy classes. The Bluetooth Low Energy Scanner Example shows how to develop Bluetooth - Low Energy applications using the Qt Bluetooth API. The application covers + Low Energy applications using the \l{QtBluetooth}{Qt Bluetooth API}. The application covers scanning for Low Energy devices, scanning their services and reading the service characteristics and descriptors. |