diff options
author | Alex Blasche <alexander.blasche@theqtcompany.com> | 2016-06-03 10:18:41 +0200 |
---|---|---|
committer | Alex Blasche <alexander.blasche@theqtcompany.com> | 2016-06-06 13:14:35 +0000 |
commit | f59d75eb8b161be9c58d1fe534afa2fa08cf4382 (patch) | |
tree | 2c0cd80fe1ed7ba0bdb5341cfe1e8fc29da27983 | |
parent | 5e8994a4fa83f4c2795978f8b9ae893cefc69160 (diff) | |
download | qtconnectivity-f59d75eb8b161be9c58d1fe534afa2fa08cf4382.tar.gz |
Make the usage of a dummy backend obvious in the QtBluetooth docs
Task-number: QTBUG-53749
Change-Id: I6e7832b4a5a70bed153fb8b0718b3c66177ffd58
Reviewed-by: Martin Smith <martin.smith@theqtcompany.com>
-rw-r--r-- | src/bluetooth/doc/src/bluetooth-index.qdoc | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/src/bluetooth/doc/src/bluetooth-index.qdoc b/src/bluetooth/doc/src/bluetooth-index.qdoc index b0ba62a0..5fd96539 100644 --- a/src/bluetooth/doc/src/bluetooth-index.qdoc +++ b/src/bluetooth/doc/src/bluetooth-index.qdoc @@ -63,6 +63,19 @@ import statement in your \c .qml file: \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 such as Windows desktop +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. + +The usage of the dummy backend is highlighted via an appropriate warning while building and running. + \section2 Guides \list \li \l {Qt Bluetooth Overview}{Classic Bluetooth Overview} |