summaryrefslogtreecommitdiffstats
path: root/src/bluetooth/doc/src
diff options
context:
space:
mode:
authorAlex Blasche <alexander.blasche@digia.com>2014-05-26 14:56:49 +0200
committerAlex Blasche <alexander.blasche@digia.com>2014-05-26 14:56:49 +0200
commitf334ea4b196950c4074e7513626aabeef3d99d7f (patch)
treeccb07d59afbb60a92b80a061645c8013aab9b96c /src/bluetooth/doc/src
parent3910d9ffcc11db7b3beb7f2b6f0c1754103cfacb (diff)
parent552f1a164d627720942414915fb56ae7d3b7ef22 (diff)
Merge branch 'dev' into btle
Conflicts: examples/bluetooth/bluetooth.pro src/bluetooth/bluez/bluez.pri src/bluetooth/doc/src/bluetooth-index.qdoc src/bluetooth/qbluetoothdevicediscoveryagent_bluez.cpp src/bluetooth/qbluetoothdeviceinfo.cpp src/bluetooth/qbluetoothservicediscoveryagent_bluez.cpp src/bluetooth/qbluetoothservicediscoveryagent_p.h src/bluetooth/qbluetoothservicediscoveryagent_qnx.cpp Change-Id: I88b22c51a4ee95b067ef8d2b2fddb5cbff4566f8
Diffstat (limited to 'src/bluetooth/doc/src')
-rw-r--r--src/bluetooth/doc/src/bluetooth-index.qdoc22
-rw-r--r--src/bluetooth/doc/src/bluetooth-overview.qdoc4
-rw-r--r--src/bluetooth/doc/src/examples.qdoc14
3 files changed, 22 insertions, 18 deletions
diff --git a/src/bluetooth/doc/src/bluetooth-index.qdoc b/src/bluetooth/doc/src/bluetooth-index.qdoc
index e9575db1..afdf2600 100644
--- a/src/bluetooth/doc/src/bluetooth-index.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-index.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
@@ -29,15 +29,21 @@
\page qtbluetooth-index.html
\title Qt Bluetooth
\brief Qt Bluetooth enables connectivity between Bluetooth enabled devices.
+\ingroup technology-apis
+
+The Bluetooth API provides connectivity between Bluetooth enabled devices.
+
+Currently the API is supported on \l{Qt for Android}{Android},
+\l{Qt for BlackBerry}{BlackBerry 10} and
+\l{Qt for Linux/X11}{Linux} (\l{http://www.bluez.org}{Bluez 4.x}).
+
+\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
-for transferring data between devices. Currently the API is supported on
-Linux (Bluez 4.x), Android and BlackBerry 10.
-
-Bluetooth connectivity is based on basic device management, such as scanning
-for devices, gathering information about them, and exchanging data between
-them.
+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.
\section1 Getting started
@@ -70,6 +76,7 @@ import statement in your \c .qml file:
\list
\li \l {scanner}{QML Bluetooth Scanner}
\li \l {picturetransfer}{QML Bluetooth Picture Push}
+ \li \l {pingpong}{QML Bluetooth PingPong}
\li \l {lowenergyscanner}{Bluetooth Low Energy Scanner}
\li \l {heartlistener}{Heart Listener}
\endlist
@@ -77,7 +84,6 @@ import statement in your \c .qml file:
\list
\li \l {btchat}{Bluetooth Chat}
\li \l {btscanner}{Bluetooth Scanner}
- \li \l {bttennis}{Bluetooth Tennis}
\li \l {btfiletransfer}{Bluetooth File Transfer}
\endlist
\endlist
diff --git a/src/bluetooth/doc/src/bluetooth-overview.qdoc b/src/bluetooth/doc/src/bluetooth-overview.qdoc
index 8842f483..2a5d8de2 100644
--- a/src/bluetooth/doc/src/bluetooth-overview.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-overview.qdoc
@@ -55,7 +55,7 @@
\section1 Retrieving Local Device Information
The Qt Bluetooth API has three main purposes. The first one is to
- obtain local and remote device information. The first steps in retrieving device information is
+ obtain local and remote device information. The first steps in retrieving device information are
to check if Bluetooth is available on the device and read the local device address and name.
QBluetoothLocalDevice is the class that provides all of this information. Additionally you can use it
to turn Bluetooth on/off, set the visibility of the device and determine the current connections.
@@ -69,7 +69,7 @@
your own and fill them with data, the easier way is to use the QBluetoothDeviceDiscoveryAgent to
start an automated search for visible Bluetooth devices within the connectable range.
- \snippet doc_src_qtbluetooth.cpp discovery
+ \snippet doc_src_qtbluetooth.cpp device_discovery
\section1 Pushing Files to Remote Devices
diff --git a/src/bluetooth/doc/src/examples.qdoc b/src/bluetooth/doc/src/examples.qdoc
index 08759874..f53d7127 100644
--- a/src/bluetooth/doc/src/examples.qdoc
+++ b/src/bluetooth/doc/src/examples.qdoc
@@ -1,9 +1,9 @@
/****************************************************************************
**
-** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
-** This file is part of the documentation of the Qt local connectivty modules.
+** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
@@ -45,9 +45,8 @@
\li Example
\li Description
\row
- \li \l{bttennis}{Bluetooth Tennis}
- \li The classic game of \l {http://en.wikipedia.org/wiki/Pong}{Pong}. Supports multiplayer
- over Bluetooth and touch-to-play functionality on devices that support NFC.
+ \li \l{btchat}{Bluetooth Chat}
+ \li Simple chat server and client via Bluetooth.
\row
\li \l{btfiletransfer}{Bluetooth File Transfer}
\li Transfer files between Bluetooth devices.
@@ -62,9 +61,8 @@
\li Example
\li Description
\row
- \li \l{bttennis}{QML Bluetooth Tennis}
- \li The tennis game using a QML interface to the Bluetooth API. It
- must connect to an instance of the C++ \l{bttennis}{Bluetooth Tennis} game to play.
+ \li \l{pingpong}{QML Bluetooth PingPong}
+ \li A QML ping pong game demonstrating Bluetooth socket communication between two devices.
\row
\li \l{scanner}{QML Bluetooth Scanner}
\li A QML implementation of the Bluetooth device scanner.