summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndreas Eliasson <andreas.eliasson@qt.io>2022-03-15 15:06:19 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-03-29 06:13:29 +0000
commit8a8f9af1a980a198d1125c15d5493108964ecec0 (patch)
tree40df10cfcd2f776f47d6a4ef5fef88a598c3f853
parent5cbefeb81abacec924663e09c234934db977ad97 (diff)
Doc: Revise Qt Bluetooth module landing page
Task-number: QTBUG-100369 Change-Id: Ic86515dc16000ae2df4cf6cf53d9def5297cb489 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io> (cherry picked from commit 47de378effd16661d2fb320f362ee6d26e8a52c7) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/bluetooth/doc/src/bluetooth-index.qdoc51
1 files changed, 26 insertions, 25 deletions
diff --git a/src/bluetooth/doc/src/bluetooth-index.qdoc b/src/bluetooth/doc/src/bluetooth-index.qdoc
index e4a192f0..62459e09 100644
--- a/src/bluetooth/doc/src/bluetooth-index.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-index.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2019 The Qt Company Ltd.
+** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
@@ -83,52 +83,52 @@ Windows 10 version 1507, with slightly improved service discovery since Windows
\section1 Overview
Bluetooth is a short-range (less than 100 meters) wireless technology. It
-has a reasonably high data transfer rate of 2.1 Mbit/s, which makes it ideal
+has a data transfer rate of 2.1 Mbps, which makes it ideal
for transferring data between devices. Bluetooth connectivity is based on
basic device management, such as scanning for devices, gathering information
about them, and exchanging data between them.
-Qt Bluetooth supports Bluetooth Low Energy development for client/central role use cases.
-Further details can be found in the
+Qt Bluetooth supports Bluetooth Low Energy development for client/central role
+use cases. Further details can be found in the
\l {Bluetooth Low Energy Overview}{Bluetooth Low Energy Overview} section.
-\include module-use.qdocinc using qt module
-\snippet doc/snippets/CMakeLists.txt 0
+\section1 Using the Module
-See also the \l {Build with CMake} overview.
+\include {module-use.qdocinc} {using the c++ api}
-\section2 Building with \c qmake
+\section2 Building with CMake
-Add \c bluetooth to the \c QT variable:
+\include {module-use.qdocinc} {building with cmake} {Bluetooth}
-\snippet snippets.pro contacts project modification
+\section2 Building with qmake
+
+\include {module-use.qdocinc} {building_with_qmake} {bluetooth}
\section1 Related Information
\section2 Building Qt Bluetooth
-Despite the fact that the module can be built for all Qt platforms,
-the module is not ported to all of them. Not supported platforms
-employ a fake or dummy backend which is automatically selected when the
-platform is not supported. The dummy backend reports appropriate error messages
-and values which allow the Qt Bluetooth developer to detect at runtime that the
-current platform is not supported. The dummy backend is also selected on Linux if
-BlueZ development headers are not found during build time or Qt was built without
-Qt D-Bus support.
+Even though the module can be built for all Qt platforms, the module is not
+ported to all of them. Non-supported platforms employ a dummy backend that is
+automatically selected when the platform is not supported. The dummy backend
+reports appropriate error messages and values, which enables you to detect at
+runtime that the current platform is not supported. The dummy backend is also
+selected on Linux if BlueZ development headers are not found during build time
+or Qt was built without Qt D-Bus support.
The usage of the dummy backend is highlighted via an appropriate warning while building and running.
\section3 \macos Specific
The Bluetooth API on \macos requires a certain type of event dispatcher
-that in Qt causes a dependency to QGuiApplication. However, you can set the
+that in Qt causes a dependency to \l QGuiApplication. However, you can set the
environment variable \c {QT_EVENT_DISPATCHER_CORE_FOUNDATION=1} to circumvent
this issue.
Applications that don't use Classic Bluetooth will find a subset of QtBluetooth
-is available, as CoreBluetooth (Bluetooth LE) do not require either of
-QApplication or QGuiApplication.
+is available, as CoreBluetooth (Bluetooth LE) don't require \l QApplication or
+\l QGuiApplication.
-\section2 Guides
+\section2 Articles and Guides
\list
\li \l {Qt Bluetooth Overview}{Classic Bluetooth Overview}
\li \l {Bluetooth Low Energy Overview}
@@ -168,9 +168,10 @@ The \l QtBluetooth module exports the following
\li Enables logging of the \l {Qt for Windows} implementation
\endtable
-Logging categories can be used to enable additional warning and debug output
-for QtBluetooth. More detailed information about logging can be found in \l QLoggingCategory.
-A quick way to enable all QtBluetooth logging is to add the following line to the \c main() function:
+Logging categories enable additional warning and debug output for QtBluetooth.
+More detailed information about logging is found in \l QLoggingCategory. A
+quick way to enable all QtBluetooth logging is to add the following line to the
+\c main() function:
\code
QLoggingCategory::setFilterRules(QStringLiteral("qt.bluetooth* = true"));