summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2012-09-25 16:24:31 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-09-29 12:27:10 +0200
commit3f4a920f87842e1bbb20f72ce04d6da7a866ab1d (patch)
tree9460b0a381c35e9137a60ec79c3070e51cd84334 /src
parentd8a179128c0fa8e9cc482df58b9334c696602be6 (diff)
Qt Bluetooth: Created \qmlmodule and \module pages
These pages will list the C++ classes and the QML types in Qt Bluetooth. Removed extra groups. Change-Id: I27d7004d804cc0cc29af997f3a11fcc9f9477efb Reviewed-by: Alex <ablasche@gmail.com>
Diffstat (limited to 'src')
-rw-r--r--src/bluetooth/doc/src/bluetooth-cpp.qdoc20
-rw-r--r--src/bluetooth/doc/src/bluetooth-qml.qdoc15
-rw-r--r--src/bluetooth/qbluetooth.cpp6
-rw-r--r--src/bluetooth/qbluetoothaddress.cpp5
-rw-r--r--src/bluetooth/qbluetoothdevicediscoveryagent.cpp5
-rw-r--r--src/bluetooth/qbluetoothdeviceinfo.cpp5
-rw-r--r--src/bluetooth/qbluetoothhostinfo.cpp4
-rw-r--r--src/bluetooth/qbluetoothlocaldevice.cpp5
-rw-r--r--src/bluetooth/qbluetoothservicediscoveryagent.cpp5
-rw-r--r--src/bluetooth/qbluetoothserviceinfo.cpp17
-rw-r--r--src/bluetooth/qbluetoothsocket.cpp5
-rw-r--r--src/bluetooth/qbluetoothtransfermanager.cpp5
-rw-r--r--src/bluetooth/qbluetoothtransferreply.cpp5
-rw-r--r--src/bluetooth/qbluetoothtransferrequest.cpp5
-rw-r--r--src/bluetooth/qbluetoothuuid.cpp6
-rw-r--r--src/bluetooth/ql2capserver.cpp5
-rw-r--r--src/bluetooth/qrfcommserver.cpp5
-rw-r--r--src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp7
-rw-r--r--src/imports/bluetooth/qdeclarativebluetoothservice.cpp8
-rw-r--r--src/imports/bluetooth/qdeclarativebluetoothsocket.cpp9
20 files changed, 58 insertions, 89 deletions
diff --git a/src/bluetooth/doc/src/bluetooth-cpp.qdoc b/src/bluetooth/doc/src/bluetooth-cpp.qdoc
index 4dcb6021..425b905d 100644
--- a/src/bluetooth/doc/src/bluetooth-cpp.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-cpp.qdoc
@@ -24,28 +24,22 @@
** $QT_END_LICENSE$
**
****************************************************************************/
-
-
-
/*!
-\page bluetooth-cpp.html
+\module QtBluetooth
\title Qt Bluetooth C++ API
\brief An API enabling basic Bluetooth operations like scanning for devices
and connecting them.
-\ingroup qtconnectivity
-\ingroup qtconnectivity-c++
-
-The Qt Bluetooth C++ API enables an application to scan for devices and connect and
-interact with them in a more flexible way than the \l{Qt Bluetooth QML API}.
-\section1 Classes
+ The \l{Qt Bluetooth} C++ API enables an application to scan for devices and
+ connect and interact with them in a more flexible way than the \l{Qt
+ Bluetooth QML API}.
-\list
-\annotatedlist connectivity-bluetooth
-\endlist
+ To use the C++ library in your application, add the following configuration
+ option to your \c .pro file:
+ \snippet doc_src_qtbluetooth.pro contacts project modification
*/
diff --git a/src/bluetooth/doc/src/bluetooth-qml.qdoc b/src/bluetooth/doc/src/bluetooth-qml.qdoc
index 36c4d4fd..84a7da5f 100644
--- a/src/bluetooth/doc/src/bluetooth-qml.qdoc
+++ b/src/bluetooth/doc/src/bluetooth-qml.qdoc
@@ -28,27 +28,20 @@
/*!
-\page bluetooth-qml.html
-
+\qmlmodule QtBluetooth 5.0
\title Qt Bluetooth QML API
\brief A QML API enabling basic Bluetooth operations like scanning for devices
and connecting them.
-\ingroup qtconnectivity
-\ingroup qtconnectivity-qml
-
The Qt Bluetooth QML API enables an application to scan for devices and connect and
interact with them in an easier way than the C++ Classes. However, it is a bit
more limited than the C++ API. You can always use the C++ API to create QML
plugins with the flexibility you need.
-\tableofcontents
-
-\section1 QML Types
+To use the classes of the module in your application you need the following
+import statement in your \c .qml file:
-\list
-\annotatedlist bluetooth-qml
-\endlist
+\snippet doc_src_qtbluetooth.qml import
*/
diff --git a/src/bluetooth/qbluetooth.cpp b/src/bluetooth/qbluetooth.cpp
index 9aa33332..d498be22 100644
--- a/src/bluetooth/qbluetooth.cpp
+++ b/src/bluetooth/qbluetooth.cpp
@@ -47,10 +47,10 @@ namespace QBluetooth {
/*!
\namespace QBluetooth
- \brief The QBluetooth namespace provides classes and functions related to Bluetooth.
-
- \ingroup connectivity-bluetooth
\inmodule QtBluetooth
+ \brief The QBluetooth namespace provides classes and functions related to
+ Bluetooth.
+
*/
/*!
diff --git a/src/bluetooth/qbluetoothaddress.cpp b/src/bluetooth/qbluetoothaddress.cpp
index f42e45f6..a69c41cb 100644
--- a/src/bluetooth/qbluetoothaddress.cpp
+++ b/src/bluetooth/qbluetoothaddress.cpp
@@ -46,10 +46,9 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\class QBluetoothAddress
- \brief The QBluetoothAddress class assigns an address to the Bluetooth device.
-
- \ingroup connectivity-bluetooth
\inmodule QtBluetooth
+ \brief The QBluetoothAddress class assigns an address to the Bluetooth
+ device.
This class holds a Bluetooth address in a platform- and protocol-independent manner.
*/
diff --git a/src/bluetooth/qbluetoothdevicediscoveryagent.cpp b/src/bluetooth/qbluetoothdevicediscoveryagent.cpp
index 7de1c6b6..ca98ed11 100644
--- a/src/bluetooth/qbluetoothdevicediscoveryagent.cpp
+++ b/src/bluetooth/qbluetoothdevicediscoveryagent.cpp
@@ -46,10 +46,9 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\class QBluetoothDeviceDiscoveryAgent
- \brief The QBluetoothDeviceDiscoveryAgent class discovers the Bluetooth devices nearby.
-
- \ingroup connectivity-bluetooth
\inmodule QtBluetooth
+ \brief The QBluetoothDeviceDiscoveryAgent class discovers the Bluetooth
+ devices nearby.
To discover the nearby Bluetooth devices:
\list
diff --git a/src/bluetooth/qbluetoothdeviceinfo.cpp b/src/bluetooth/qbluetoothdeviceinfo.cpp
index 1a0a850a..b230a95c 100644
--- a/src/bluetooth/qbluetoothdeviceinfo.cpp
+++ b/src/bluetooth/qbluetoothdeviceinfo.cpp
@@ -48,10 +48,9 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\class QBluetoothDeviceInfo
- \brief The QBluetoothDeviceInfo class stores information about the Bluetooth device.
-
- \ingroup connectivity-bluetooth
\inmodule QtBluetooth
+ \brief The QBluetoothDeviceInfo class stores information about the Bluetooth
+ device.
QBluetoothDeviceInfo provides information about a Bluetooth device's name, address and class of device.
*/
diff --git a/src/bluetooth/qbluetoothhostinfo.cpp b/src/bluetooth/qbluetoothhostinfo.cpp
index b2e1c9fb..a684addc 100644
--- a/src/bluetooth/qbluetoothhostinfo.cpp
+++ b/src/bluetooth/qbluetoothhostinfo.cpp
@@ -46,12 +46,10 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\class QBluetoothHostInfo
+ \inmodule QtBluetooth
\brief The QBluetoothHostInfo class encapsulates the details of a local
QBluetooth device.
- \ingroup connectivity-bluetooth
- \inmodule QtBluetooth
-
This class holds the name and address of a local Bluetooth device.
*/
diff --git a/src/bluetooth/qbluetoothlocaldevice.cpp b/src/bluetooth/qbluetoothlocaldevice.cpp
index 8ef849ae..c245ef47 100644
--- a/src/bluetooth/qbluetoothlocaldevice.cpp
+++ b/src/bluetooth/qbluetoothlocaldevice.cpp
@@ -50,10 +50,9 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\class QBluetoothLocalDevice
- \brief The QBluetoothLocalDevice class enables access to the local Bluetooth device.
-
- \ingroup connectivity-bluetooth
\inmodule QtBluetooth
+ \brief The QBluetoothLocalDevice class enables access to the local Bluetooth
+ device.
QBluetoothLocalDevice provides functions for getting and setting the state of local Bluetooth
devices.
diff --git a/src/bluetooth/qbluetoothservicediscoveryagent.cpp b/src/bluetooth/qbluetoothservicediscoveryagent.cpp
index c5b359bc..f0ab0213 100644
--- a/src/bluetooth/qbluetoothservicediscoveryagent.cpp
+++ b/src/bluetooth/qbluetoothservicediscoveryagent.cpp
@@ -48,10 +48,9 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\class QBluetoothServiceDiscoveryAgent
- \brief The QBluetoothServiceDiscoveryAgent class enables you to query for Bluetooth services.
-
- \ingroup connectivity-bluetooth
\inmodule QtBluetooth
+ \brief The QBluetoothServiceDiscoveryAgent class enables you to query for
+ Bluetooth services.
To query the services provided by all contactable Bluetooth devices:
\list
diff --git a/src/bluetooth/qbluetoothserviceinfo.cpp b/src/bluetooth/qbluetoothserviceinfo.cpp
index b39dc43b..e449e7ff 100644
--- a/src/bluetooth/qbluetoothserviceinfo.cpp
+++ b/src/bluetooth/qbluetoothserviceinfo.cpp
@@ -48,10 +48,10 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\class QBluetoothServiceInfo::Sequence
- \brief The Sequence class stores attributes of a Bluetooth Data Element Sequence.
-
- \ingroup connectivity-bluetooth
\inmodule QtBluetooth
+ \brief The Sequence class stores attributes of a Bluetooth Data Element
+ Sequence.
+
*/
/*!
@@ -68,10 +68,10 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\class QBluetoothServiceInfo::Alternative
- \brief The Alternative class stores attributes of a Bluetooth Data Element Alternative.
-
- \ingroup connectivity-bluetooth
\inmodule QtBluetooth
+ \brief The Alternative class stores attributes of a Bluetooth Data Element
+ Alternative.
+
*/
/*!
@@ -88,10 +88,9 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\class QBluetoothServiceInfo
- \brief The QBluetoothServiceInfo class enables access to the attributes of a Bluetooth service.
-
- \ingroup connectivity-bluetooth
\inmodule QtBluetooth
+ \brief The QBluetoothServiceInfo class enables access to the attributes of a
+ Bluetooth service.
QBluetoothServiceInfo provides information about a service offered by a Bluetooth device.
*/
diff --git a/src/bluetooth/qbluetoothsocket.cpp b/src/bluetooth/qbluetoothsocket.cpp
index 662d30c8..83f5173e 100644
--- a/src/bluetooth/qbluetoothsocket.cpp
+++ b/src/bluetooth/qbluetoothsocket.cpp
@@ -54,10 +54,9 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\class QBluetoothSocket
- \brief The QBluetoothSocket class enables connection to a Bluetooth device running an RFCOMM server.
-
- \ingroup connectivity-bluetooth
\inmodule QtBluetooth
+ \brief The QBluetoothSocket class enables connection to a Bluetooth device
+ running an RFCOMM server.
QBluetoothSocket supports two socket types, \l {QBluetoothSocket::L2capSocket}{L2CAP} and
\l {QBluetoothSocket::RfcommSocket}{RFCOMM}.
diff --git a/src/bluetooth/qbluetoothtransfermanager.cpp b/src/bluetooth/qbluetoothtransfermanager.cpp
index 28069b99..6ddd90d7 100644
--- a/src/bluetooth/qbluetoothtransfermanager.cpp
+++ b/src/bluetooth/qbluetoothtransfermanager.cpp
@@ -46,10 +46,9 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\class QBluetoothTransferManager
- \brief The QBluetoothTransferManager class transfers data to another device using Object Push Profile (OPP).
-
- \ingroup connectivity-bluetooth
\inmodule QtBluetooth
+ \brief The QBluetoothTransferManager class transfers data to another device
+ using Object Push Profile (OPP).
QBluetoothTransferManager uses OBEX to send get and put commands to remote devices.
*/
diff --git a/src/bluetooth/qbluetoothtransferreply.cpp b/src/bluetooth/qbluetoothtransferreply.cpp
index 937ff55c..46c0fda2 100644
--- a/src/bluetooth/qbluetoothtransferreply.cpp
+++ b/src/bluetooth/qbluetoothtransferreply.cpp
@@ -48,10 +48,9 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\class QBluetoothTransferReply
- \brief The QBluetoothTransferReply class stores the response for a data transfer request.
-
- \ingroup connectivity-bluetooth
\inmodule QtBluetooth
+ \brief The QBluetoothTransferReply class stores the response for a data
+ transfer request.
In additional to a copy of the QBluetoothTransferRequest object used to create the request,
QBluetoothTransferReply contains the contents of the reply itself.
diff --git a/src/bluetooth/qbluetoothtransferrequest.cpp b/src/bluetooth/qbluetoothtransferrequest.cpp
index 85f70fd4..c96e02c7 100644
--- a/src/bluetooth/qbluetoothtransferrequest.cpp
+++ b/src/bluetooth/qbluetoothtransferrequest.cpp
@@ -48,10 +48,9 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\class QBluetoothTransferRequest
- \brief The QBluetoothTransferRequest class stores information about a data transfer request.
-
- \ingroup connectivity-bluetooth
\inmodule QtBluetooth
+ \brief The QBluetoothTransferRequest class stores information about a
+ data transfer request.
QBluetoothTransferRequest is part of the Bluetooth Transfer API and is the class holding the
information necessary to initiate a transfer over Bluetooth.
diff --git a/src/bluetooth/qbluetoothuuid.cpp b/src/bluetooth/qbluetoothuuid.cpp
index 3178dbd2..c29a044b 100644
--- a/src/bluetooth/qbluetoothuuid.cpp
+++ b/src/bluetooth/qbluetoothuuid.cpp
@@ -59,10 +59,10 @@ Q_GLOBAL_STATIC_WITH_ARGS(QUuid, baseUuid, ("{00000000-0000-1000-8000-00805F9B34
/*!
\class QBluetoothUuid
- \brief The QBluetoothUuid class generates a UUID for each Bluetooth service.
-
- \ingroup connectivity-bluetooth
\inmodule QtBluetooth
+ \brief The QBluetoothUuid class generates a UUID for each Bluetooth
+ service.
+
*/
/*!
diff --git a/src/bluetooth/ql2capserver.cpp b/src/bluetooth/ql2capserver.cpp
index ccfdc950..bf002c0e 100644
--- a/src/bluetooth/ql2capserver.cpp
+++ b/src/bluetooth/ql2capserver.cpp
@@ -47,10 +47,9 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\class QL2capServer
- \brief The QL2capServer class allows you to connect to a service using the L2CAP protocol.
-
- \ingroup connectivity-bluetooth
\inmodule QtBluetooth
+ \brief The QL2capServer class allows you to connect to a service using the
+ L2CAP protocol.
QL2capServer is used to implement Bluetooth services over L2CAP.
diff --git a/src/bluetooth/qrfcommserver.cpp b/src/bluetooth/qrfcommserver.cpp
index 7800f721..de9ab007 100644
--- a/src/bluetooth/qrfcommserver.cpp
+++ b/src/bluetooth/qrfcommserver.cpp
@@ -47,10 +47,9 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\class QRfcommServer
- \brief The QRfcommServer class uses the RFCOMM protocol to communicate with a Bluetooth device.
-
- \ingroup connectivity-bluetooth
\inmodule QtBluetooth
+ \brief The QRfcommServer class uses the RFCOMM protocol to communicate with
+ a Bluetooth device.
QRfcommServer is used to implement Bluetooth services over RFCOMM.
diff --git a/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp b/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp
index 70831bc2..f7428744 100644
--- a/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp
+++ b/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp
@@ -51,10 +51,9 @@
/*!
\qmltype BluetoothDiscoveryModel
\instantiates QDeclarativeBluetoothDiscoveryModel
- \brief Enables you to search for the Bluetooth devices and services in range.
-
- \ingroup bluetooth-qml
- \inmodule QtBluetooth
+ \inqmlmodule QtBluetooth 5.0
+ \brief Enables you to search for the Bluetooth devices and services in
+ range.
The BluetoothDiscoveryModel type was introduced in \b{QtBluetooth 5.0}.
diff --git a/src/imports/bluetooth/qdeclarativebluetoothservice.cpp b/src/imports/bluetooth/qdeclarativebluetoothservice.cpp
index 767e24aa..b38dee34 100644
--- a/src/imports/bluetooth/qdeclarativebluetoothservice.cpp
+++ b/src/imports/bluetooth/qdeclarativebluetoothservice.cpp
@@ -52,12 +52,10 @@
/* ==================== QDeclarativeBluetoothService ======================= */
/*!
- \qmltype BluetoothService
+ \qmltype BluetoothService
\instantiates QDeclarativeBluetoothService
- \brief Provides information about a particular Bluetooth service.
-
- \ingroup bluetooth-qml
- \inmodule QtBluetooth
+ \inqmlmodule QtBluetooth 5.0
+ \brief Provides information about a particular Bluetooth service.
\sa QBluetoothAddress
\sa QBluetoothSocket
diff --git a/src/imports/bluetooth/qdeclarativebluetoothsocket.cpp b/src/imports/bluetooth/qdeclarativebluetoothsocket.cpp
index fca5d3e3..a282879a 100644
--- a/src/imports/bluetooth/qdeclarativebluetoothsocket.cpp
+++ b/src/imports/bluetooth/qdeclarativebluetoothsocket.cpp
@@ -56,12 +56,11 @@
/* ==================== QDeclarativeBluetoothSocket ======================= */
/*!
- \qmltype BluetoothSocket
+ \qmltype BluetoothSocket
\instantiates QDeclarativeBluetoothSocket
- \brief Enables you to connect and communicate with a Bluetooth service or device.
-
- \ingroup bluetooth-qml
- \inmodule QtBluetooth
+ \inqmlmodule QtBluetooth 5.0
+ \brief Enables you to connect and communicate with a Bluetooth service or
+ device.
\sa QBluetoothSocket
\sa QDataStream