summaryrefslogtreecommitdiffstats
path: root/src/bluetooth/doc
diff options
context:
space:
mode:
authorAndreas Buhr <andreas.buhr@qt.io>2021-08-19 17:10:32 +0200
committerAndreas Buhr <andreas.buhr@qt.io>2021-08-19 23:24:06 +0200
commitfdf6b6bd84f3ae853b97946f2e9ea3d7a5c35426 (patch)
treec8a895fa098fc689031c8e13c760ff0b90873ec9 /src/bluetooth/doc
parent391fd67c685bc8fe1f769b5ae3c65095f1322ad0 (diff)
Replace "Getting Started" by "Using the Module" in QtBluetooth docs
Pick-to: 6.2 Fixes: QTBUG-94894 Change-Id: I628af802fc589e163dc9087fa7fc3fd7db71caba Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/bluetooth/doc')
-rw-r--r--src/bluetooth/doc/snippets/CMakeLists.txt4
-rw-r--r--src/bluetooth/doc/src/bluetooth-index.qdoc10
2 files changed, 11 insertions, 3 deletions
diff --git a/src/bluetooth/doc/snippets/CMakeLists.txt b/src/bluetooth/doc/snippets/CMakeLists.txt
new file mode 100644
index 00000000..757fada8
--- /dev/null
+++ b/src/bluetooth/doc/snippets/CMakeLists.txt
@@ -0,0 +1,4 @@
+# ![0]
+find_package(Qt6 COMPONENTS Bluetooth REQUIRED)
+target_link_libraries(mytarget PRIVATE Qt6::Bluetooth)
+# ![0]
diff --git a/src/bluetooth/doc/src/bluetooth-index.qdoc b/src/bluetooth/doc/src/bluetooth-index.qdoc
index 88e645d4..7146e347 100644
--- a/src/bluetooth/doc/src/bluetooth-index.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-index.qdoc
@@ -92,10 +92,14 @@ Qt Bluetooth supports Bluetooth Low Energy development for client/central role u
Further details can be found in the
\l {Bluetooth Low Energy Overview}{Bluetooth Low Energy Overview} section.
-\section1 Getting Started
+\include module-use.qdocinc using qt module
+\snippet doc/snippets/CMakeLists.txt 0
-To use the C++ library in your application, add the following configuration
-option to your \c .pro file:
+See also the \l {Build with CMake} overview.
+
+\section2 Building with qmake
+
+Add \c bluetooth to the \c QT variable:
\snippet snippets.pro contacts project modification