From 7622a55810a96961ad657207e0ad99d6b6ff98d1 Mon Sep 17 00:00:00 2001 From: veshivas Date: Wed, 22 Feb 2012 15:33:38 +0100 Subject: Modified the \brief text for the Bluetooth C++ classes and the QML elements. Change-Id: I3c455739afe9d63eb822a0462c7e786bd83259ee Reviewed-by: Gary Aish Reviewed-by: Alex --- src/bluetooth/qbluetooth.cpp | 2 +- src/bluetooth/qbluetoothaddress.cpp | 2 +- src/bluetooth/qbluetoothdevicediscoveryagent.cpp | 3 +-- src/bluetooth/qbluetoothdeviceinfo.cpp | 2 +- src/bluetooth/qbluetoothlocaldevice.cpp | 2 +- src/bluetooth/qbluetoothservicediscoveryagent.cpp | 3 +-- src/bluetooth/qbluetoothserviceinfo.cpp | 8 +++----- src/bluetooth/qbluetoothsocket.cpp | 2 +- src/bluetooth/qbluetoothtransfermanager.cpp | 3 +-- src/bluetooth/qbluetoothtransferreply.cpp | 3 +-- src/bluetooth/qbluetoothtransferrequest.cpp | 3 +-- src/bluetooth/qbluetoothuuid.cpp | 2 +- src/bluetooth/ql2capserver.cpp | 2 +- src/bluetooth/qrfcommserver.cpp | 2 +- src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp | 2 +- src/imports/bluetooth/qdeclarativebluetoothservice.cpp | 2 +- src/imports/bluetooth/qdeclarativebluetoothsocket.cpp | 2 +- 17 files changed, 19 insertions(+), 26 deletions(-) (limited to 'src') diff --git a/src/bluetooth/qbluetooth.cpp b/src/bluetooth/qbluetooth.cpp index 8aba16c4..0ce8e3ee 100644 --- a/src/bluetooth/qbluetooth.cpp +++ b/src/bluetooth/qbluetooth.cpp @@ -47,7 +47,7 @@ namespace QBluetooth { /*! \namespace QBluetooth - \brief The QBluetooth namespace contains functions and definitions related to Bluetooth. + \brief The QBluetooth namespace provides classes and functions related to Bluetooth. \ingroup connectivity-bluetooth \inmodule QtBluetooth diff --git a/src/bluetooth/qbluetoothaddress.cpp b/src/bluetooth/qbluetoothaddress.cpp index 333aa484..f4377c98 100644 --- a/src/bluetooth/qbluetoothaddress.cpp +++ b/src/bluetooth/qbluetoothaddress.cpp @@ -46,7 +46,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE /*! \class QBluetoothAddress - \brief The QBluetoothAddress class provides a Bluetooth address. + \brief The QBluetoothAddress class assigns an address to the Bluetooth device. \ingroup connectivity-bluetooth \inmodule QtBluetooth diff --git a/src/bluetooth/qbluetoothdevicediscoveryagent.cpp b/src/bluetooth/qbluetoothdevicediscoveryagent.cpp index d7de048d..3213c4a8 100644 --- a/src/bluetooth/qbluetoothdevicediscoveryagent.cpp +++ b/src/bluetooth/qbluetoothdevicediscoveryagent.cpp @@ -46,8 +46,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE /*! \class QBluetoothDeviceDiscoveryAgent - \brief The QBluetoothDeviceDiscoveryAgent class provides an API for discovering nearby - Bluetooth devices. + \brief The QBluetoothDeviceDiscoveryAgent class discovers the Bluetooth devices nearby. \ingroup connectivity-bluetooth \inmodule QtBluetooth diff --git a/src/bluetooth/qbluetoothdeviceinfo.cpp b/src/bluetooth/qbluetoothdeviceinfo.cpp index 2523535b..11bd2799 100644 --- a/src/bluetooth/qbluetoothdeviceinfo.cpp +++ b/src/bluetooth/qbluetoothdeviceinfo.cpp @@ -48,7 +48,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE /*! \class QBluetoothDeviceInfo - \brief The QBluetoothDeviceInfo class provides information about Bluetooth devices. + \brief The QBluetoothDeviceInfo class stores information about the Bluetooth device. \ingroup connectivity-bluetooth \inmodule QtBluetooth diff --git a/src/bluetooth/qbluetoothlocaldevice.cpp b/src/bluetooth/qbluetoothlocaldevice.cpp index e715acf3..a13f4afa 100644 --- a/src/bluetooth/qbluetoothlocaldevice.cpp +++ b/src/bluetooth/qbluetoothlocaldevice.cpp @@ -50,7 +50,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE /*! \class QBluetoothLocalDevice - \brief The QBluetoothLocalDevice class provides access to local Bluetooth devices. + \brief The QBluetoothLocalDevice class enables access to the local Bluetooth device. \ingroup connectivity-bluetooth \inmodule QtBluetooth diff --git a/src/bluetooth/qbluetoothservicediscoveryagent.cpp b/src/bluetooth/qbluetoothservicediscoveryagent.cpp index 06fd028e..983b3cb6 100644 --- a/src/bluetooth/qbluetoothservicediscoveryagent.cpp +++ b/src/bluetooth/qbluetoothservicediscoveryagent.cpp @@ -48,8 +48,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE /*! \class QBluetoothServiceDiscoveryAgent - \brief The QBluetoothServiceDiscoveryAgent class provides an API for querying the services - provided by a Bluetooth device. + \brief The QBluetoothServiceDiscoveryAgent class enables you to query for Bluetooth services. \ingroup connectivity-bluetooth \inmodule QtBluetooth diff --git a/src/bluetooth/qbluetoothserviceinfo.cpp b/src/bluetooth/qbluetoothserviceinfo.cpp index 379d46b4..146c6ec9 100644 --- a/src/bluetooth/qbluetoothserviceinfo.cpp +++ b/src/bluetooth/qbluetoothserviceinfo.cpp @@ -48,8 +48,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE /*! \class QBluetoothServiceInfo::Sequence - \brief The Sequence class provides a data type for Bluetooth Data - Element Sequence attributes. + \brief The Sequence class stores attributes of a Bluetooth Data Element Sequence. \ingroup connectivity-bluetooth \inmodule QtBluetooth @@ -69,8 +68,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE /*! \class QBluetoothServiceInfo::Alternative - \brief The Alternative class provides a data type for Bluetooth Data - Element Alternative attributes. + \brief The Alternative class stores attributes of a Bluetooth Data Element Alternative. \ingroup connectivity-bluetooth \inmodule QtBluetooth @@ -90,7 +88,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE /*! \class QBluetoothServiceInfo - \brief The QBluetoothServiceInfo class provides information about services. + \brief The QBluetoothServiceInfo class enables access to the attributes of a Bluetooth service. \ingroup connectivity-bluetooth \inmodule QtBluetooth diff --git a/src/bluetooth/qbluetoothsocket.cpp b/src/bluetooth/qbluetoothsocket.cpp index 7de977ed..b2563cb5 100644 --- a/src/bluetooth/qbluetoothsocket.cpp +++ b/src/bluetooth/qbluetoothsocket.cpp @@ -54,7 +54,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE /*! \class QBluetoothSocket - \brief The QBluetoothSocket class provides a Bluetooth socket. + \brief The QBluetoothSocket class enables connection to a Bluetooth device running an RFCOMM server. \ingroup connectivity-bluetooth \inmodule QtBluetooth diff --git a/src/bluetooth/qbluetoothtransfermanager.cpp b/src/bluetooth/qbluetoothtransfermanager.cpp index d9441b41..1610c6b5 100644 --- a/src/bluetooth/qbluetoothtransfermanager.cpp +++ b/src/bluetooth/qbluetoothtransfermanager.cpp @@ -46,8 +46,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE /*! \class QBluetoothTransferManager - \brief The QBluetoothTransferManager class allows the application to send data objects to other - devices. Currently implemented using OPP. + \brief The QBluetoothTransferManager class transfers data to another device using Object Push Profile (OPP). \ingroup connectivity-bluetooth \inmodule QtBluetooth diff --git a/src/bluetooth/qbluetoothtransferreply.cpp b/src/bluetooth/qbluetoothtransferreply.cpp index 200ba3d8..546e6878 100644 --- a/src/bluetooth/qbluetoothtransferreply.cpp +++ b/src/bluetooth/qbluetoothtransferreply.cpp @@ -48,8 +48,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE /*! \class QBluetoothTransferReply - \brief The QBluetoothTransferReply class contains the data and headers for a request sent with - QBluetoothTranferManager. + \brief The QBluetoothTransferReply class stores the response for a data transfer request. \ingroup connectivity-bluetooth \inmodule QtBluetooth diff --git a/src/bluetooth/qbluetoothtransferrequest.cpp b/src/bluetooth/qbluetoothtransferrequest.cpp index 7c03e67f..b8d94ab3 100644 --- a/src/bluetooth/qbluetoothtransferrequest.cpp +++ b/src/bluetooth/qbluetoothtransferrequest.cpp @@ -48,8 +48,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE /*! \class QBluetoothTransferRequest - \brief The QBluetoothTransferRequest class holds a request to be sent with - QBluetoothTransferManager. + \brief The QBluetoothTransferRequest class stores information about a data transfer request. \ingroup connectivity-bluetooth \inmodule QtBluetooth diff --git a/src/bluetooth/qbluetoothuuid.cpp b/src/bluetooth/qbluetoothuuid.cpp index d56a6102..76bdbd7c 100644 --- a/src/bluetooth/qbluetoothuuid.cpp +++ b/src/bluetooth/qbluetoothuuid.cpp @@ -59,7 +59,7 @@ Q_GLOBAL_STATIC_WITH_ARGS(QUuid, baseUuid, ("{00000000-0000-1000-8000-00805F9B34 /*! \class QBluetoothUuid - \brief The QBluetoothUuid class provides a Bluetooth UUID. + \brief The QBluetoothUuid class generates a UUID for each Bluetooth service. \ingroup connectivity-bluetooth \inmodule QtBluetooth diff --git a/src/bluetooth/ql2capserver.cpp b/src/bluetooth/ql2capserver.cpp index 735da87e..eaf8f2b2 100644 --- a/src/bluetooth/ql2capserver.cpp +++ b/src/bluetooth/ql2capserver.cpp @@ -47,7 +47,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE /*! \class QL2capServer - \brief The QL2capServer class provides an L2CAP server. + \brief The QL2capServer class allows you to connect to a service using the L2CAP protocol. \ingroup connectivity-bluetooth \inmodule QtBluetooth diff --git a/src/bluetooth/qrfcommserver.cpp b/src/bluetooth/qrfcommserver.cpp index 6c1329aa..fc0440dd 100644 --- a/src/bluetooth/qrfcommserver.cpp +++ b/src/bluetooth/qrfcommserver.cpp @@ -47,7 +47,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE /*! \class QRfcommServer - \brief The QRfcommServer class provides an RFCOMM server. + \brief The QRfcommServer class uses the RFCOMM protocol to communicate with a Bluetooth device. \ingroup connectivity-bluetooth \inmodule QtBluetooth diff --git a/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp b/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp index 4a0c544e..e501dd6d 100644 --- a/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp +++ b/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp @@ -50,7 +50,7 @@ /*! \qmlclass BluetoothDiscoveryModel QDeclarativeBluetoothDiscoveryModel - \brief The BluetoothDisoceryModel element provides access device and service scanning + \brief Enables you to search for the Bluetooth devices and services in range. \ingroup bluetooth-qml \inmodule QtBluetooth diff --git a/src/imports/bluetooth/qdeclarativebluetoothservice.cpp b/src/imports/bluetooth/qdeclarativebluetoothservice.cpp index c5846dbe..37bffcf3 100644 --- a/src/imports/bluetooth/qdeclarativebluetoothservice.cpp +++ b/src/imports/bluetooth/qdeclarativebluetoothservice.cpp @@ -53,7 +53,7 @@ /*! \qmlclass BluetoothService QDeclarativeBluetoothService - \brief The BluetoothService element contains all the information available for a single Bluetooth service.\. + \brief Provides information about a particular Bluetooth service. \ingroup bluetooth-qml \inmodule QtBluetooth diff --git a/src/imports/bluetooth/qdeclarativebluetoothsocket.cpp b/src/imports/bluetooth/qdeclarativebluetoothsocket.cpp index 5c32745a..4fa683e6 100644 --- a/src/imports/bluetooth/qdeclarativebluetoothsocket.cpp +++ b/src/imports/bluetooth/qdeclarativebluetoothsocket.cpp @@ -57,7 +57,7 @@ /*! \qmlclass BluetoothSocket QDeclarativeBluetoothSocket - \brief The BluetoothSocket element represents a single bluetooth client socket. + \brief Enables you to connect and communicate with a Bluetooth service or device. \ingroup bluetooth-qml \inmodule QtBluetooth -- cgit v1.2.3