summaryrefslogtreecommitdiffstats
path: root/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc
diff options
context:
space:
mode:
authorIvan Solovev <ivan.solovev@qt.io>2023-03-27 11:46:33 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2023-03-29 09:34:53 +0000
commit525a4ef1205af5fad6727a9c532481058f7c8003 (patch)
tree0001761dcdc57bf1f8d489e46927fda6778daa3e /examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc
parenta948901bbb6bf7303419bd7823d7294cb13efd7b (diff)
HeartRate Game example: general clean-up
C++ code cleanup: * Fix include headers * Minor code-style improvements * Silence the warning about an uncreatable type by explicitly using QML_UNCREATABLE. We do not create the type in QML anyway. * Do not limit Windows platform to simulator mode. The example works perfectly on Windows. Build-system improvements: * Use qt_standard_project_setup() and PRIVATE linking in CMake Docs: * Add Connectivity category * Link to the documentation page which gives a full example overview Task-number: QTBUG-111972 Fixes: QTBUG-112194 Change-Id: I6e50d1a3e9219afbf010d6471e8f7eb802c2ef00 Reviewed-by: Juha Vuolle <juha.vuolle@qt.io> (cherry picked from commit a1f43b9dcd722527d52ceb0c7a138bd2994c1a7b) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc')
-rw-r--r--examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc5
1 files changed, 5 insertions, 0 deletions
diff --git a/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc b/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc
index d8cbb6bc..256ff243 100644
--- a/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc
+++ b/examples/bluetooth/heartrate-game/doc/src/heartrate-game.qdoc
@@ -4,6 +4,7 @@
/*!
\example heartrate-game
\title Bluetooth Low Energy Heart Rate Game
+ \meta category {Connectivity}
\brief A game demonstrating the interaction with a Bluetooth Low Energy Heart Rate
device/service.
@@ -34,6 +35,10 @@
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
+ documentation.
+
The \l {lowenergyscanner}{Bluetooth Low Energy Scanner} example might be more suitable
if a heart rate device is not available. The scanner example works with any type of Bluetooth
Low Energy peripheral device.