summaryrefslogtreecommitdiffstats
path: root/src/bluetooth/doc
diff options
context:
space:
mode:
authorAlex Blasche <alexander.blasche@qt.io>2016-11-15 13:29:46 +0100
committerAlex Blasche <alexander.blasche@qt.io>2016-11-16 06:35:06 +0000
commit0565eae7eab0b56d91e1ee0695a639f68c14b7bc (patch)
treec5650d7763264ef16da8790884d935f787aae94b /src/bluetooth/doc
parentc66bb18ec585e40294588b75e922410e7eb5d8bc (diff)
Update general QtBluetooth module introduction
iOS and macOS support for BTLE Peripheral was added. In addition we make it more obvious what features each platform supports. Eventually this can be removed. Task-number: QTBUG-57015 Change-Id: Idf7e96a02a04e0cef79e1bc4030be223210af479 Reviewed-by: Timur Pocheptsov <timur.pocheptsov@qt.io> Reviewed-by: Oliver Wolff <oliver.wolff@qt.io>
Diffstat (limited to 'src/bluetooth/doc')
-rw-r--r--src/bluetooth/doc/src/bluetooth-index.qdoc51
-rw-r--r--src/bluetooth/doc/src/bluetooth-le-overview.qdoc4
2 files changed, 48 insertions, 7 deletions
diff --git a/src/bluetooth/doc/src/bluetooth-index.qdoc b/src/bluetooth/doc/src/bluetooth-index.qdoc
index 7dd555cf..821fde0b 100644
--- a/src/bluetooth/doc/src/bluetooth-index.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-index.qdoc
@@ -33,9 +33,50 @@
The Bluetooth API provides connectivity between Bluetooth enabled devices.
-Currently, the API is supported on the following platforms: \l{Qt for Android}{Android},
-\l{Qt for iOS}{iOS}, \l{Qt for Linux/X11}{Linux}
-(\l{http://www.bluez.org}{BlueZ 4.x/5.x}) and \l{Qt for macOS}{\macos}.
+Currently, the API is supported on the following platforms:
+
+\table
+\header
+ \li API Feature
+ \li \l {Qt for Android}{Android}
+ \li \l {Qt for iOS}{iOS}
+ \li \l {Qt for Linux/X11}{Linux (BlueZ 4.x/5.x)}
+ \li \l {Qt for OS X}{macOS}
+ \li \l {Qt for WinRT}{WinRT}
+ \li \l {Qt for Windows}{Windows}
+\row
+ \li Classic Bluetooth
+ \li x
+ \li x
+ \li x
+ \li x
+ \li
+ \li
+\row
+ \li Bluetooth LE Central
+ \li x
+ \li x
+ \li x
+ \li x
+ \li x
+ \li
+\row
+ \li Bluetooth LE Peripheral
+ \li
+ \li x
+ \li x
+ \li x
+ \li
+ \li
+\row
+ \li Bluetooth LE Advertisement & Scanning
+ \li
+ \li
+ \li
+ \li
+ \li
+ \li
+\endtable
\section1 Overview
@@ -49,8 +90,8 @@ 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.
-A new addition in this Qt Bluetooth 5.7 release covers support for Bluetooth Low Energy
-applications performing the peripheral/server role. This new API is a Technology Preview.
+A new addition since the Qt Bluetooth 5.7 release covers support for Bluetooth Low Energy
+applications performing the peripheral/server role. This new API remains in Technology Preview.
\section1 Getting Started
diff --git a/src/bluetooth/doc/src/bluetooth-le-overview.qdoc b/src/bluetooth/doc/src/bluetooth-le-overview.qdoc
index 8e78c487..a2fb10d9 100644
--- a/src/bluetooth/doc/src/bluetooth-le-overview.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-le-overview.qdoc
@@ -37,8 +37,8 @@ Low Energy devices.
The Qt Bluetooth Low Energy API for the central role was introduced by Qt 5.4.
Since Qt 5.5 that part of the API is final and a compatibility guarantee is given for
future releases.
- In Qt 5.7, additional API supporting the peripheral role was added as a Technology Preview,
- with the backend only implemented for Linux/BlueZ.
+ Since Qt 5.7, additional API supporting the peripheral role was added as a Technology Preview,
+ with the backend implemented for Linux/BlueZ, iOS and macOS.
\section1 What Is Bluetooth Low Energy