summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@nokia.com>2012-02-28 16:54:20 +0100
committerQt by Nokia <qt-info@nokia.com>2012-02-29 12:39:49 +0100
commit86f234ad2de4b25eb394739ecf672132904496e2 (patch)
tree58a86b3f96c0c91666c64a3d04ddbfd0387f8e41 /src
parent7622a55810a96961ad657207e0ad99d6b6ff98d1 (diff)
Language edits to the QDoc markup
Change-Id: I13206b25dbd87ce0d066cb21842dfbd516bd2bbc Reviewed-by: Alex <alex.blasche@nokia.com>
Diffstat (limited to 'src')
-rw-r--r--src/bluetooth/qbluetooth.cpp20
-rw-r--r--src/bluetooth/qbluetoothaddress.cpp10
-rw-r--r--src/bluetooth/qbluetoothdevicediscoveryagent.cpp48
-rw-r--r--src/bluetooth/qbluetoothdeviceinfo.cpp40
-rw-r--r--src/bluetooth/qbluetoothlocaldevice.cpp34
-rw-r--r--src/bluetooth/qbluetoothservicediscoveryagent.cpp35
-rw-r--r--src/bluetooth/qbluetoothserviceinfo.cpp47
-rw-r--r--src/bluetooth/qbluetoothsocket.cpp21
-rw-r--r--src/bluetooth/qbluetoothtransfermanager.cpp4
-rw-r--r--src/bluetooth/qbluetoothtransferreply.cpp20
-rw-r--r--src/bluetooth/qbluetoothtransferrequest.cpp10
-rw-r--r--src/bluetooth/qbluetoothuuid.cpp27
-rw-r--r--src/bluetooth/ql2capserver.cpp28
-rw-r--r--src/bluetooth/qrfcommserver.cpp27
-rw-r--r--src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp10
-rw-r--r--src/imports/bluetooth/qdeclarativebluetoothservice.cpp18
-rw-r--r--src/imports/bluetooth/qdeclarativebluetoothsocket.cpp24
17 files changed, 208 insertions, 215 deletions
diff --git a/src/bluetooth/qbluetooth.cpp b/src/bluetooth/qbluetooth.cpp
index 0ce8e3ee..c0026d85 100644
--- a/src/bluetooth/qbluetooth.cpp
+++ b/src/bluetooth/qbluetooth.cpp
@@ -58,23 +58,21 @@ namespace QBluetooth {
This enum describe the security requirements of a Bluetooth service.
- \value NoSecurity The service does not require any security.
+ \value NoSecurity The service does not require any security.
- \value Authorization The service requires authorization. Device does not
- have to paired, the connection will be granted by prompting the user unless
- the device is Authorized-Paired where the connection will be made
- automatically.
+ \value Authorization The service requires authorization by the user,
+ unless the device is Authorized-Paired.
\value Authentication The service requires authentication. Device must
- paired, the user maybe prompted on connection unless the device is
+ be paired, and the user is prompted on connection unless the device is
Authorized-Paired.
- \value Encryption The service requires that the communications link be
- encrypted. This requires the device be paired.
+ \value Encryption The service requires the communication link to be
+ encrypted. This requires the device to be paired.
- \value Secure The service requires that the communications link be secure.
- Legacy pairing is not permitted, Simple Pairing from Bluetooth 2.1 or
- greater is required.
+ \value Secure The service requires the communication link to be secure.
+ Simple Pairing from Bluetooth 2.1 or greater is required.
+ Legacy pairing is not permitted.
*/
}
diff --git a/src/bluetooth/qbluetoothaddress.cpp b/src/bluetooth/qbluetoothaddress.cpp
index f4377c98..c5dbe02b 100644
--- a/src/bluetooth/qbluetoothaddress.cpp
+++ b/src/bluetooth/qbluetoothaddress.cpp
@@ -51,7 +51,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE
\ingroup connectivity-bluetooth
\inmodule QtBluetooth
- This class holds a Bluetooth address in a platform- and protocol- independent manner.
+ This class holds a Bluetooth address in a platform- and protocol-independent manner.
*/
/*!
@@ -158,7 +158,7 @@ void QBluetoothAddress::clear()
}
/*!
- Returns true if the Bluetooth address is valid, otherwise returns false.
+ Returns true if the Bluetooth address is null, otherwise returns false.
*/
bool QBluetoothAddress::isNull() const
{
@@ -167,7 +167,7 @@ bool QBluetoothAddress::isNull() const
}
/*!
- Returns true if the Bluetooth address is less than \a other; otherwise
+ Returns true if the Bluetooth address is less than \a other, otherwise
returns false.
*/
bool QBluetoothAddress::operator<(const QBluetoothAddress &other) const
@@ -179,7 +179,7 @@ bool QBluetoothAddress::operator<(const QBluetoothAddress &other) const
/*!
Compares this Bluetooth address to \a other.
- Returns true if the Bluetooth address are equal, otherwise returns false.
+ Returns true if the two Bluetooth addresses are equal, otherwise returns false.
*/
bool QBluetoothAddress::operator==(const QBluetoothAddress &other) const
{
@@ -197,7 +197,7 @@ quint64 QBluetoothAddress::toUInt64() const
}
/*!
- Returns the Bluetooth address as a string of the form XX:XX:XX:XX:XX:XX.
+ Returns the Bluetooth address as a string of the form, XX:XX:XX:XX:XX:XX.
*/
QString QBluetoothAddress::toString() const
{
diff --git a/src/bluetooth/qbluetoothdevicediscoveryagent.cpp b/src/bluetooth/qbluetoothdevicediscoveryagent.cpp
index 3213c4a8..1ab6f702 100644
--- a/src/bluetooth/qbluetoothdevicediscoveryagent.cpp
+++ b/src/bluetooth/qbluetoothdevicediscoveryagent.cpp
@@ -51,13 +51,17 @@ QTBLUETOOTH_BEGIN_NAMESPACE
\ingroup connectivity-bluetooth
\inmodule QtBluetooth
- To discovery nearby Bluetooth devices create an instance of QBluetoothDeviceDiscoveryAgent,
- connect to either the deviceDiscovered() or finished() signals and call start().
+ To discover the nearby Bluetooth devices:
+ \list
+ \o create an instance of QBluetoothDeviceDiscoveryAgent,
+ \o connect to either the deviceDiscovered() or finished() signals,
+ \o and call start().
+ \endlist
\snippet ../doc/src/snippets/devicediscovery.cpp Device discovery
- To retrieve results asynchronously connect to the deviceDiscovered() signal. To get a list of
- all discovered devices call discoveredDevices() after the finished() signal is emitted.
+ To retrieve results asynchronously, connect to the deviceDiscovered() signal. To get a list of
+ all discovered devices, call discoveredDevices() after the finished() signal.
*/
/*!
@@ -66,27 +70,27 @@ QTBLUETOOTH_BEGIN_NAMESPACE
Indicates all possible error conditions found during Bluetooth device discovery.
\value NoError No error has occurred.
- \value PoweredOff Bluetooth adaptor is powered off, power it on before doing discovery.
- \value IOFailure Writing or reading from device resulted in an error.
+ \value PoweredOff The Bluetooth adaptor is powered off, power it on before doing discovery.
+ \value IOFailure Writing or reading from the device resulted in an error.
\value UnknownError An unknown error has occurred.
*/
/*!
\enum QBluetoothDeviceDiscoveryAgent::InquiryType
- This enum describes the inquiry type used when discovering Bluetooth devices.
+ This enum describes the inquiry type used while discovering Bluetooth devices.
\value GeneralUnlimitedInquiry A general unlimited inquiry. Discovers all visible Bluetooth
devices in the local vicinity.
- \value LimitedInquiry A limited inquiry. Only discovers devices that are in limited
- inquiry mode. Not all platforms support limited inquiry. If
- limited inquiry is requested on a platform that does not
- support it general unlimited inquiry we be used instead. Setting
- LimitedInquiry is useful for 2 games that wish to find each other
- quickly. The phone scans for devices in LimitedInquiry and
- Service Discovery is only done on one or two devices speeding up the
- service scan. After the game has connected the device returns to
- GeneralUnilimitedInquiry
+ \value LimitedInquiry A limited inquiry discovers devices that are in limited
+ inquiry mode.
+
+ LimitedInquiry is not supported on all platforms. If it is requested on a platform that does not
+ support it, GeneralUnlimitedInquiry will be used instead. Setting LimitedInquiry is useful
+ for multi-player Bluetooth-based games that needs faster communication between the devices.
+ The phone scans for devices in LimitedInquiry and Service Discovery is done on one or two devices
+ to speed up the service scan. After the game has connected to the device it intends to,the device
+ returns to GeneralUnilimitedInquiry.
*/
/*!
@@ -118,7 +122,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\fn bool QBluetoothDeviceDiscoveryAgent::isActive() const
- Returns true if the agent is currently discovering Bluetooth devices, other returns false.
+ Returns true if the agent is currently discovering Bluetooth devices, otherwise returns false.
*/
/*!
@@ -140,9 +144,9 @@ QBluetoothDeviceDiscoveryAgent::~QBluetoothDeviceDiscoveryAgent()
/*!
\property QBluetoothDeviceDiscoveryAgent::inquiryType
- \brief type of inquiry scan to use when discovering devices
+ \brief type of inquiry scan to be used while discovering devices
- This property affects the type of inquiry scan which is performed when discovering devices.
+ This property affects the type of inquiry scan which is performed while discovering devices.
By default, this property is set to GeneralUnlimitedInquiry.
@@ -188,7 +192,7 @@ void QBluetoothDeviceDiscoveryAgent::start()
Stops Bluetooth device discovery. The cancel() signal is emitted once the
device discovery is canceled. start() maybe called before the cancel signal is
received. Once start() has been called the cancel signal from the prior
- discovery will be silently discarded.
+ discovery will be discarded.
*/
void QBluetoothDeviceDiscoveryAgent::stop()
{
@@ -205,7 +209,7 @@ bool QBluetoothDeviceDiscoveryAgent::isActive() const
/*!
- Returns the last error which has occurred.
+ Returns the last error.
*/
QBluetoothDeviceDiscoveryAgent::Error QBluetoothDeviceDiscoveryAgent::error() const
{
@@ -215,7 +219,7 @@ QBluetoothDeviceDiscoveryAgent::Error QBluetoothDeviceDiscoveryAgent::error() co
}
/*!
- Returns a human-readable description of the last error that occurred.
+ Returns a human-readable description of the last error.
*/
QString QBluetoothDeviceDiscoveryAgent::errorString() const
{
diff --git a/src/bluetooth/qbluetoothdeviceinfo.cpp b/src/bluetooth/qbluetoothdeviceinfo.cpp
index 11bd2799..c2304748 100644
--- a/src/bluetooth/qbluetoothdeviceinfo.cpp
+++ b/src/bluetooth/qbluetoothdeviceinfo.cpp
@@ -66,11 +66,11 @@ QTBLUETOOTH_BEGIN_NAMESPACE
\value PhoneDevice A telephone device.
\value LANAccessDevice A device that provides access to a local area network.
\value AudioVideoDevice A device capable of playback or capture of audio and/or video.
- \value PeripheralDevice A peripheral device such as a keyboard, mouse, etc.
+ \value PeripheralDevice A peripheral device such as a keyboard, mouse, and so on.
\value ImagingDevice An imaging device such as a display, printer, scanner or camera.
\value WearableDevice A wearable device such as a watch or pager.
\value ToyDevice A toy.
- \value HealthDevice A health reated device such as heart rate, or temperature.
+ \value HealthDevice A health reated device such as heart rate or temperature monitor.
\value UncategorizedDevice A device that does not fit into any of the other device classes.
*/
@@ -132,13 +132,13 @@ QTBLUETOOTH_BEGIN_NAMESPACE
\value UncategorizedAudioVideoDevice An uncategorized audio/video device.
\value WearableHeadsetDevice A wearable headset device.
- \value HandsFreeDevice A hands free device.
+ \value HandsFreeDevice A handsfree device.
\value Microphone A microphone.
\value Loudspeaker A loudspeaker.
\value Headphones Headphones.
\value PortableAudioDevice A portable audio device.
\value CarAudio A car audio device.
- \value SetTopBox A set top box.
+ \value SetTopBox A settop box.
\value HiFiAudioDevice A HiFi audio device.
\value Vcr A video cassette recorder.
\value VideoCamera A video camera.
@@ -224,7 +224,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE
\enum QBluetoothDeviceInfo::ServiceClass
This enum describes the service class of the Bluetooth device. The service class is used as a
- rudimentary form of service discovery. It is meant to provide a rudimentary list of the types
+ rudimentary form of service discovery. It is meant to provide a list of the types
of services that the device might provide.
\value NoService The device does not provide any services.
@@ -367,7 +367,7 @@ QBluetoothDeviceInfo &QBluetoothDeviceInfo::operator=(const QBluetoothDeviceInfo
}
/*!
- Returns true if the \a other QBluetoothDeviceInfo object and this are identical
+ Returns true if the \a other QBluetoothDeviceInfo object and this are identical.
*/
bool QBluetoothDeviceInfo::operator==(const QBluetoothDeviceInfo &other) const
{
@@ -461,11 +461,11 @@ void QBluetoothDeviceInfo::setServiceUuids(const QList<QBluetoothUuid> &uuids, D
/*!
Returns the list of service UUIDS supported by the device. If \a completeness is not 0 it will
- be set to DataComplete if the returned list is the complete list of UUIDs supported by the
- device. DataIncomplete if additional service UUIDs are supported by the device and
- DataUnavailable if no service UUID information is available.
+ be set to DataComplete and the complete list of UUIDs supported by the device is returned.
+ DataIncomplete if additional service UUIDs are supported by the device and DataUnavailable if
+ no service UUID information is available.
- This function requires both Bluetooth devices to support the 2.1 specification.
+ This function requires both the Bluetooth devices to support the 2.1 specification.
*/
QList<QBluetoothUuid> QBluetoothDeviceInfo::serviceUuids(DataCompleteness *completeness) const
{
@@ -478,10 +478,10 @@ QList<QBluetoothUuid> QBluetoothDeviceInfo::serviceUuids(DataCompleteness *compl
}
/*!
- Returns the completeness of the service UUID list. If DataComplete is returned then
- serviceUuids() will return a complete list of service UUIDs supported by the device. Otherwise
- serviceUuids() will only return a partial or empty list of service UUIDs. To get a full list
- of services supported by the device a full service discovery needs to be performed.
+ Returns the completeness of the service UUID list. If DataComplete is returned,
+ serviceUuids() returns the complete list of service UUIDs supported by the device, otherwise
+ only the partial or empty list of service UUIDs. To get a list
+ of all services supported by the device, a full service discovery needs to be performed.
*/
QBluetoothDeviceInfo::DataCompleteness QBluetoothDeviceInfo::serviceUuidsCompleteness() const
{
@@ -491,7 +491,7 @@ QBluetoothDeviceInfo::DataCompleteness QBluetoothDeviceInfo::serviceUuidsComplet
}
/*!
- Sets the manufacturer specific data returned by Extended Inquiry Responses to \a data.
+ Sets the manufacturer-specific data returned by Extended Inquiry Responses to \a data.
*/
void QBluetoothDeviceInfo::setManufacturerSpecificData(const QByteArray &data)
{
@@ -499,8 +499,8 @@ void QBluetoothDeviceInfo::setManufacturerSpecificData(const QByteArray &data)
}
/*!
- Returns the manufacturer specific data. If \a available is not 0 it is set to true if
- manufacturer specific data is available; otherwise it is set to false.
+ Returns the manufacturer-specific data. If \a available is not 0, it is set to true if
+ manufacturer-specific data is available; otherwise it is set to false.
*/
QByteArray QBluetoothDeviceInfo::manufacturerSpecificData(bool *available) const
{
@@ -509,7 +509,7 @@ QByteArray QBluetoothDeviceInfo::manufacturerSpecificData(bool *available) const
}
/*!
- Returns true if the QBluetoothDeviceInfo object is created from cached data
+ Returns true if the QBluetoothDeviceInfo object is created from cached data.
*/
bool QBluetoothDeviceInfo::isCached() const
{
@@ -519,8 +519,8 @@ bool QBluetoothDeviceInfo::isCached() const
}
/*!
- Used by the system to set the \a cached flag if the QBluetoothDeviceInfo is created from cached data. Cached information
- may not be as accurate as data read from a live device.
+ Used by the system to set the \a cached flag if the QBluetoothDeviceInfo is created from cached data. Cached
+ information may not be as accurate as data read from an active device.
*/
void QBluetoothDeviceInfo::setCached(bool cached)
{
diff --git a/src/bluetooth/qbluetoothlocaldevice.cpp b/src/bluetooth/qbluetoothlocaldevice.cpp
index a13f4afa..2abab9ca 100644
--- a/src/bluetooth/qbluetoothlocaldevice.cpp
+++ b/src/bluetooth/qbluetoothlocaldevice.cpp
@@ -62,7 +62,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\enum QBluetoothLocalDevice::Pairing
- This enum describes the pairing state between two Bluetooth devices.
+ This enum describes the pairing state between the two Bluetooth devices.
\value Unpaired The Bluetooth devices are not paired.
\value Paired The Bluetooth devices are paired. The system will prompt the user for
@@ -89,18 +89,17 @@ QTBLUETOOTH_BEGIN_NAMESPACE
This enum describes the most of the local Bluetooth device.
- \value HostPoweredOff Powers the device down
+ \value HostPoweredOff Power off the device
\value HostConnectable Remote Bluetooth devices can connect to the local Bluetooth device
- if they have previously been paired with it or otherwise know its
- address. This powers up the device if it was powered off.
+ if they have previously been paired with it or otherwise know its address. This powers up the
+ device if it was powered off.
\value HostDiscoverable Remote Bluetooth devices can discover the presence of the local
- Bluetooth device. The device will also be connectable, and powered on.
+ Bluetooth device. The device will also be connectable, and powered on.
\value HostDiscoverableLimitedInquiry Remote Bluetooth devices can discover the presence of the local
- Bluetooth device when performing a limited inquiry. This should be used for
- locating services that are only made discoverable for a limited period of time.
- This can speed up discovery between games for example, since service
- discovery can be skipped on devices not in limited enquiry more. This
- is not supported on all platforms. The device will also be connectable, and powered on.
+ Bluetooth device when performing a limited inquiry. This should be used for locating services that are
+ only made discoverable for a limited period of time. This can speed up discovery between gaming devices,
+ as service discovery can be skipped on devices not in LimitedInquiry mode. In this mode, the device will
+ be connectable and powered on, if required.
*/
@@ -127,7 +126,7 @@ QBluetoothLocalDevice::~QBluetoothLocalDevice()
}
/*!
- Returns true the QBluetoothLocalDevice represents an available local Bluetooth device;
+ Returns true if the QBluetoothLocalDevice represents an available local Bluetooth device;
otherwise return false.
*/
bool QBluetoothLocalDevice::isValid() const
@@ -138,7 +137,7 @@ bool QBluetoothLocalDevice::isValid() const
/*!
\fn void QBluetoothLocalDevice::setHostMode(QBluetoothLocalDevice::HostMode mode)
- Sets the host mode the this local Bluetooth device to \a mode.
+ Sets the host mode of this local Bluetooth device to \a mode.
*/
/*!
@@ -168,7 +167,7 @@ bool QBluetoothLocalDevice::isValid() const
/*!
\fn QBluetoothLocalDevice::powerOn()
- Powers on the device on returning it to the hostMode() state is was in when powered down
+ Powers on the device after returning it to the hostMode() state, if it was powered off.
*/
/*!
@@ -178,7 +177,7 @@ bool QBluetoothLocalDevice::isValid() const
/*!
\fn QBluetoothLocalDevice::hostModeStateChanged(QBluetoothLocalDevice::HostMode state)
- The \a state of the host has transitioned to a different HostMode
+ The \a state of the host has transitioned to a different HostMode.
*/
/*!
@@ -213,9 +212,8 @@ bool QBluetoothLocalDevice::isValid() const
/*!
\fn QBluetoothLocalDevice::requestPairing(const QBluetoothAddress &address, Pairing pairing)
- Set the \a pairing status with \a address. The results are returned via
- the signal pairingFinished(). Caution: creating a pairing may take minutes, and can require
- the user to acknowledge dialogs.
+ Set the \a pairing status with \a address. The results are returned by the signal, pairingFinished().
+ Caution: creating a pairing may take minutes, and may require the user to acknowledge.
*/
/*!
@@ -226,7 +224,7 @@ bool QBluetoothLocalDevice::isValid() const
/*!
\fn QBluetoothLocalDevice::error(QBluetoothLocalDevice::Error error)
- Signal emitted for pairing if there's an exceptional \a error
+ Signal emitted if there's an exceptional \a error while pairing.
*/
diff --git a/src/bluetooth/qbluetoothservicediscoveryagent.cpp b/src/bluetooth/qbluetoothservicediscoveryagent.cpp
index 983b3cb6..8e3a0544 100644
--- a/src/bluetooth/qbluetoothservicediscoveryagent.cpp
+++ b/src/bluetooth/qbluetoothservicediscoveryagent.cpp
@@ -53,17 +53,19 @@ QTBLUETOOTH_BEGIN_NAMESPACE
\ingroup connectivity-bluetooth
\inmodule QtBluetooth
- To query the services provided by all contactable Bluetooth devices create an instance of
- QBluetoothServiceDiscoveryAgent, connect to either the serviceDiscovered() or finished()
- signals and call start().
+ To query the services provided by all contactable Bluetooth devices:
+ \list
+ \o create an instance of QBluetoothServiceDiscoveryAgent,
+ \o connect to either the serviceDiscovered() or finished() signals,
+ \o and call start().
\snippet ../doc/src/snippets/servicediscovery.cpp Service discovery
- By default a minimal service discovery is performed. In this mode the QBluetotohServiceInfo
+ By default a minimal service discovery is performed. In this mode, the QBluetotohServiceInfo
objects returned are guaranteed to contain only device and service UUID information. Depending
- on platform and device capabilities other service information may also be available. For most
+ on platform and device capabilities, other service information may also be available. For most
use cases this is adequate as QBluetoothSocket::connectToService() will perform additional
- discovery if required. If full service information is required pass \l FullDiscovery as the
+ discovery if required. If full service information is required, pass \l FullDiscovery as the
discoveryMode parameter to start().
*/
@@ -83,8 +85,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE
This enum describes the service discovery mode.
\value MinimalDiscovery Performs a minimal service discovery. The QBluetoothServiceInfo
- objects returned may be incomplete and are only guaranteed to
- contain device and service UUID information.
+ objects returned may be incomplete and are only guaranteed to contain device and service UUID information.
\value FullDiscovery Performs a full service discovery.
*/
@@ -120,7 +121,7 @@ QBluetoothServiceDiscoveryAgent::QBluetoothServiceDiscoveryAgent(QObject *parent
/*!
Constructs a new QBluetoothServiceDiscoveryAgent for \a remoteAddress and with \a parent.
- If \a remoteAddress is null services will be discovred on all contactable Bluetooth
+ If \a remoteAddress is null, services will be discovred on all contactable Bluetooth
devices.
*/
QBluetoothServiceDiscoveryAgent::QBluetoothServiceDiscoveryAgent(const QBluetoothAddress &remoteAddress, QObject *parent)
@@ -258,12 +259,12 @@ bool QBluetoothServiceDiscoveryAgent::isActive() const
/*!
Returns the type of error that last occurred. If service discovery is done
- on a signle address it will returns errors when trying to discover services
- on that device. If the alternate constructor is used and devices are
- discovered by a scan, then errors doing service discovery on individual
- devices are not saved and no signals are emitted. In this case errors are
- fairly normal since some devices may not respond to discovery or
- may no longer be in range. As such errors are surpressed. If no services
+ on a signle address it will return errors that occured while trying to discover
+ services on that device. If the alternate constructor is used and devices are
+ discovered by a scan, errors during service discovery on individual
+ devices are not saved and no signals are emitted. In this case, errors are
+ fairly normal as some devices may not respond to discovery or
+ may no longer be in range. Such errors are surpressed. If no services
are returned, it can be assumed no services could be discovered.
*/
@@ -275,8 +276,8 @@ QBluetoothServiceDiscoveryAgent::Error QBluetoothServiceDiscoveryAgent::error()
}
/*!
- Returns a human-readable description of the last error that occurred when
- doing service discovery on a single device.
+ Returns a human-readable description of the last error that occurred during
+ service discovery on a single device.
*/
QString QBluetoothServiceDiscoveryAgent::errorString() const
{
diff --git a/src/bluetooth/qbluetoothserviceinfo.cpp b/src/bluetooth/qbluetoothserviceinfo.cpp
index 146c6ec9..231a98c9 100644
--- a/src/bluetooth/qbluetoothserviceinfo.cpp
+++ b/src/bluetooth/qbluetoothserviceinfo.cpp
@@ -110,8 +110,8 @@ QTBLUETOOTH_BEGIN_NAMESPACE
\value ServiceRecordHandle Specifies a service record from which attributes can be retrieved
\value ServiceName Name of the Bluetooth service in the primary language.
\value ServiceDescription Description of the Bluetooth service in the primary language.
- \value ServiceProvider Name of the company / entity that provides the Bluetooth
- service primary language.
+ \value ServiceProvider Name of the company / entity that provides the Bluetooth service primary
+ language.
*/
/*!
@@ -127,25 +127,24 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\fn bool QBluetoothServiceInfo::isRegistered() const
- Returns true if the service info is registered with the platforms service discovery protocol
- (SDP) implementation; otherwise returns false.
+ Returns true if the service information is registered with the platform's Service Discovery Protocol
+ (SDP) implementation, otherwise returns false.
*/
/*!
\fn bool QBluetoothServiceInfo::registerService() const
- Registers this service with the platforms service discovery protocol (SDP) implementation,
+ Registers this service with the platform's Service Discovery Protocol (SDP) implementation,
making it findable by other devices when they perform service discovery. Returns true if the
service is successfully registered, otherwise returns false. Once registered changes to the record
- cannot be made. The service must be unregistered and registered.
+ cannot be made. The service must be unregistered and registered again with the changes.
*/
/*!
\fn bool QBluetoothServiceInfo::unregisterService() const
- Unregisters this service with the platforms service discovery protocol (SDP) implementation.
-
- This service will not longer be findable by other devices via service discovery.
+ Unregisters this service with the platform's Service Discovery Protocol (SDP) implementation.
+ After this, the service will no longer be findable by other devices through service discovery.
Returns true if the service is successfully unregistered, otherwise returns false.
*/
@@ -324,9 +323,9 @@ QBluetoothServiceInfo::~QBluetoothServiceInfo()
}
/*!
- Returns true if the Bluetooth service info object is valid; otherwise returns false.
+ Returns true if the QBluetoothServiceInfo object is valid, otherwise returns false.
- An invalid Bluetooth service info has no attributes.
+ An invalid QBluetoothServiceInfo object will have no attributes.
*/
bool QBluetoothServiceInfo::isValid() const
{
@@ -336,9 +335,9 @@ bool QBluetoothServiceInfo::isValid() const
}
/*!
- Returns true if the Bluetooth service info object is considered complete; otherwise returns false.
+ Returns true if the QBluetoothServiceInfo object is considered complete, otherwise returns false.
- A complete service info contains a ProtocolDescriptorList attribute.
+ A complete QBluetoothServiceInfo object contains a ProtocolDescriptorList attribute.
*/
bool QBluetoothServiceInfo::isComplete() const
{
@@ -370,7 +369,7 @@ void QBluetoothServiceInfo::setDevice(const QBluetoothDeviceInfo &device)
/*!
Sets the attribute identified by \a attributeId to \a value.
- IF the service info is registered with the platforms SDP database the database entry is also
+ If the service information is registered with the platforms SDP database, the database entry is also
updated.
\sa isRegistered(), registerService()
@@ -399,7 +398,7 @@ QVariant QBluetoothServiceInfo::attribute(quint16 attributeId) const
}
/*!
- Returns a list of all attribute ids that this service info has.
+ Returns a list of all attribute ids that the QBluetoothServiceInfo object has.
*/
QList<quint16> QBluetoothServiceInfo::attributes() const
{
@@ -409,7 +408,7 @@ QList<quint16> QBluetoothServiceInfo::attributes() const
}
/*!
- Returns true if the service info contains the attribute \a attributeId; otherwise returns
+ Returns true if the QBluetoothServiceInfo object contains the attribute \a attributeId, otherwise returns
false.
*/
bool QBluetoothServiceInfo::contains(quint16 attributeId) const
@@ -420,7 +419,7 @@ bool QBluetoothServiceInfo::contains(quint16 attributeId) const
}
/*!
- Removes the attribute \a attributeId from this service info.
+ Removes the attribute \a attributeId from the QBluetoothServiceInfo object.
*/
void QBluetoothServiceInfo::removeAttribute(quint16 attributeId)
{
@@ -433,7 +432,7 @@ void QBluetoothServiceInfo::removeAttribute(quint16 attributeId)
}
/*!
- Returns the protocol that this service uses.
+ Returns the protocol that the QBluetoothServiceInfo object uses.
*/
QBluetoothServiceInfo::Protocol QBluetoothServiceInfo::socketProtocol() const
{
@@ -450,10 +449,10 @@ QBluetoothServiceInfo::Protocol QBluetoothServiceInfo::socketProtocol() const
/*!
This is a convenience function. Returns the protocol/service multiplexer for services which
- support the L2CAP protocol. Otherwise returns -1.
+ support the L2CAP protocol, otherwise returns -1.
- This function is equivalent to extracting the information from the
- QBluetoothServiceInfo::Sequence returned from
+ This function is equivalent to extracting the information from
+ QBluetoothServiceInfo::Sequence returned by
QBluetoothServiceInfo::attribute(QBluetoothServiceInfo::ProtocolDescriptorList).
*/
int QBluetoothServiceInfo::protocolServiceMultiplexer() const
@@ -470,10 +469,10 @@ int QBluetoothServiceInfo::protocolServiceMultiplexer() const
/*!
This is a convenience function. Returns the server channel for services which support the
- RFCOMM protocol. Otherwise returns -1.
+ RFCOMM protocol, otherwise returns -1.
- This function is equivalent to extracting the information from the
- QBluetoothServiceInfo::Sequence returned from
+ This function is equivalent to extracting the information from
+ QBluetoothServiceInfo::Sequence returned by
QBluetoothServiceInfo::attribute(QBluetootherServiceInfo::ProtocolDescriptorList).
*/
int QBluetoothServiceInfo::serverChannel() const
diff --git a/src/bluetooth/qbluetoothsocket.cpp b/src/bluetooth/qbluetoothsocket.cpp
index b2563cb5..caf0b7aa 100644
--- a/src/bluetooth/qbluetoothsocket.cpp
+++ b/src/bluetooth/qbluetoothsocket.cpp
@@ -67,7 +67,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE
\l {QBluetoothSocket::RfcommSocket}{RFCOMM} is a reliable, stream-oriented socket. RFCOMM
sockets emulate an RS-232 serial port.
- To create a connection to a Bluetooth service create a socket of the appropriate type and call
+ To create a connection to a Bluetooth service, create a socket of the appropriate type and call
connectToService() passing the Bluetooth address and port number. QBluetoothSocket will emit
the connected() signal when the connection is established.
@@ -89,14 +89,13 @@ QTBLUETOOTH_BEGIN_NAMESPACE
This enum describes the state of the Bluetooth socket.
- \value UnconnectedState Socket is not connected.
+ \value UnconnectedState Socket is not connected.
\value ServiceLookupState Socket is querying connection parameters.
\value ConnectingState Socket is attempting to connect to a device.
\value ConnectedState Socket is connected to a device.
- \value BoundState 242.nmp.nokia.com
-_IceTransSocketUNIXConnect: Cannot connect to non-local host saisd Socket is bound to a local address and port.
+ \value BoundState Socket is bound to a local address and port.
\value ClosingState Socket is connected and will be closed once all pending data is
- written to the socket.
+ written to the socket.
\value ListeningState Socket is listening for incoming connections.
*/
@@ -186,7 +185,7 @@ _IceTransSocketUNIXConnect: Cannot connect to non-local host saisd Socket
/*!
\fn quint16 QBluetoothSocket::localPort() const
- Returns the port number of the local socket if available; otherwise returns 0.
+ Returns the port number of the local socket if available, otherwise returns 0.
*/
/*!
@@ -204,7 +203,7 @@ _IceTransSocketUNIXConnect: Cannot connect to non-local host saisd Socket
/*!
\fn quint16 QBluetoothSocket::peerPort() const
- Return the port number of the peer socket if available; otherwise returns 0.
+ Return the port number of the peer socket if available, otherwise returns 0.
*/
/*!
@@ -443,7 +442,7 @@ void QBluetoothSocket::setSocketError(QBluetoothSocket::SocketError error_)
/*!
Start device discovery for \a service and open the socket with \a openMode. If the socket
- is created with a service uuid device address we must use service discovery to find the
+ is created with a service uuid device address, use service discovery to find the
port number to connect to.
*/
@@ -576,8 +575,8 @@ void QBluetoothSocket::close()
}
/*!
- Set the socket to use \a socketDescriptor with a type of \a socketType
- which is in state \a socketState and mode \a openMode.
+ Set the socket to use \a socketDescriptor with a type of \a socketType,
+ which is in state, \a socketState, and mode, \a openMode.
Returns true on success
*/
@@ -591,7 +590,7 @@ bool QBluetoothSocket::setSocketDescriptor(int socketDescriptor, SocketType sock
}
/*!
- Returns the platform specific socket descriptor, if available
+ Returns the platform-specific socket descriptor, if available.
*/
int QBluetoothSocket::socketDescriptor() const
diff --git a/src/bluetooth/qbluetoothtransfermanager.cpp b/src/bluetooth/qbluetoothtransfermanager.cpp
index 1610c6b5..0855f22f 100644
--- a/src/bluetooth/qbluetoothtransfermanager.cpp
+++ b/src/bluetooth/qbluetoothtransfermanager.cpp
@@ -66,8 +66,8 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\fn QBluetoothTransferReply *QBluetoothTransferManager::put(const QBluetoothTransferRequest &request, QIODevice *data)
- Sends the contents of \a data to the remote device \a request and returns a new
- QBluetoothTransferReply, that can be used to track the request's progress.
+ Sends the contents of \a data to the remote device identified by \a request, and returns a new
+ QBluetoothTransferReply that can be used to track the request's progress.
*/
diff --git a/src/bluetooth/qbluetoothtransferreply.cpp b/src/bluetooth/qbluetoothtransferreply.cpp
index 546e6878..ffd2a2d2 100644
--- a/src/bluetooth/qbluetoothtransferreply.cpp
+++ b/src/bluetooth/qbluetoothtransferreply.cpp
@@ -57,7 +57,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE
QBluetoothTransferReply contains the contents of the reply itself.
QBluetoothTransferReply is a sequential-access QIODevice, which means that once data is read
- from the object, it no longer kept by the device. It is therefore the application's
+ from the object, it is no longer kept by the device. It is the application's
responsibility to keep this data if it needs to. Whenever more data is received and processed,
the readyRead() signal is emitted.
@@ -66,7 +66,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE
the contents (for example, decompressing and removing the protocol overhead).
Even though QBluetoothTransferReply is a QIODevice connected to the contents of the reply, it
- also emits the uploadProgress() signal, which indicates the progress of the upload for
+ emits the uploadProgress() signal, which indicates the progress of the upload for
operations that have such content.
*/
@@ -115,7 +115,7 @@ void QBluetoothTransferReply::abort()
*/
/*!
- Constructs a new QBluetoothTransferReply with parent \a parent.
+ Constructs a new QBluetoothTransferReply with \a parent.
*/
QBluetoothTransferReply::QBluetoothTransferReply(QObject *parent)
: QObject(parent), d_ptr(new QBluetoothTransferReplyPrivate)
@@ -132,7 +132,7 @@ QBluetoothTransferReply::~QBluetoothTransferReply()
}
/*!
- Returns the attribute associated with the code \a code. If the attribute has not been set, it
+ Returns the attribute associated with \a code. If the attribute has not been set, it
returns an invalid QVariant.
*/
QVariant QBluetoothTransferReply::attribute(QBluetoothTransferRequest::Attribute code) const
@@ -144,13 +144,13 @@ QVariant QBluetoothTransferReply::attribute(QBluetoothTransferRequest::Attribute
/*!
\fn bool QBluetoothTransferReply::isFinished() const
- Returns true if this reply has finished; otherwise returns false.
+ Returns true if this reply has finished, otherwise false.
*/
/*!
\fn bool QBluetoothTransferReply::isRunning() const
- Returns true if this reply is running; otherwise returns false.
+ Returns true if this reply is running, otherwise false.
*/
/*!
@@ -184,7 +184,7 @@ void QBluetoothTransferReply::setOperation(QBluetoothTransferManager::Operation
/*!
\fn QBluetoothTransferReply::setAttribute(QBluetoothTransferRequest::Attribute code, const QVariant &value)
- Set the attribute associated with the code \a code to the value \a value.
+ Set the attribute associated with the \a code to \a value.
*/
void QBluetoothTransferReply::setAttribute(QBluetoothTransferRequest::Attribute code, const QVariant &value)
{
@@ -195,7 +195,7 @@ void QBluetoothTransferReply::setAttribute(QBluetoothTransferRequest::Attribute
/*!
\fn QBluetoothTransferReply::setManager(QBluetoothTransferManager *manager)
- Set the reply's manager to manager \a manager.
+ Set the reply's manager to the \a manager.
*/
void QBluetoothTransferReply::setManager(QBluetoothTransferManager *manager)
@@ -207,13 +207,13 @@ void QBluetoothTransferReply::setManager(QBluetoothTransferManager *manager)
/*!
\fn TransferError QBluetoothTransferReply::error() const
- The error code of the error that happened.
+ The error code of the error that occurred.
*/
/*!
\fn QString QBluetoothTransferReply::errorString() const
- String describing the error. Can be displayed to the user.
+ String describing the error. Can be displayed to the user.
*/
QBluetoothTransferReplyPrivate::QBluetoothTransferReplyPrivate()
diff --git a/src/bluetooth/qbluetoothtransferrequest.cpp b/src/bluetooth/qbluetoothtransferrequest.cpp
index b8d94ab3..3ae3a34a 100644
--- a/src/bluetooth/qbluetoothtransferrequest.cpp
+++ b/src/bluetooth/qbluetoothtransferrequest.cpp
@@ -64,8 +64,8 @@ QTBLUETOOTH_BEGIN_NAMESPACE
Attribute codes for QBluetoothTransferRequest and QBluetoothTransferReply.
- \value DescriptionAttribute A textural description of the object being transferred. May be
- display in the UI of the remote device.
+ \value DescriptionAttribute A textual description of the object being transferred.
+ May be displayed in the UI of the remote device.
\value TimeAttribute Time attribute of the object being transferred.
\value TypeAttribute MIME type of the object being transferred.
\value LengthAttribute Length in bytes of the object being transferred.
@@ -74,7 +74,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE
*/
/*!
- Constructs a new Bluetooth transfer request to the device wit address \a address.
+ Constructs a new Bluetooth transfer request to the device with \a address.
*/
QBluetoothTransferRequest::QBluetoothTransferRequest(const QBluetoothAddress &address)
:d_ptr(new QBluetoothTransferRequestPrivate)
@@ -102,7 +102,7 @@ QBluetoothTransferRequest::~QBluetoothTransferRequest()
}
/*!
- Returns the attribute associated with code \a code. If the attribute has not been set, it
+ Returns the attribute associated with \a code. If the attribute has not been set, it
returns \a defaultValue.
\sa setAttribute(), QBluetoothTransferRequest::Attribute
@@ -119,7 +119,7 @@ QVariant QBluetoothTransferRequest::attribute(Attribute code, const QVariant &de
}
/*!
- Sets the attribute associated with code \a code to be value \a value. If the attribute is
+ Sets the attribute associated with \a code to \a value. If the attribute is
already set, the previous value is discarded. If \a value is an invalid QVariant, the attribute
is unset.
diff --git a/src/bluetooth/qbluetoothuuid.cpp b/src/bluetooth/qbluetoothuuid.cpp
index 76bdbd7c..928b1741 100644
--- a/src/bluetooth/qbluetoothuuid.cpp
+++ b/src/bluetooth/qbluetoothuuid.cpp
@@ -104,9 +104,8 @@ Q_GLOBAL_STATIC_WITH_ARGS(QUuid, baseUuid, ("{00000000-0000-1000-8000-00805F9B34
implicitly converted into a QBluetoothUuid when necessary.
\value PublicBrowseGroup Public browse group service class. Services which have the public
- browse group in their
- \l {QBluetoothServiceInfo::BrowseGroupList}{browse group list} are
- discoverable by remote devices.
+ browse group in their \l {QBluetoothServiceInfo::BrowseGroupList}{browse group list} are discoverable
+ by the remote devices.
\value ObexObjectPush OBEX object push service UUID.
\value ServiceDiscoveryServer
\value BrowseGroupDescriptor Browser group descriptor
@@ -171,7 +170,7 @@ QBluetoothUuid::QBluetoothUuid()
}
/*!
- Constructs a new Bluetooth UUID from the protocol UUID \a uuid.
+ Constructs a new Bluetooth UUID from the protocol \a uuid.
*/
QBluetoothUuid::QBluetoothUuid(ProtocolUuid uuid)
: QUuid(uuid, baseUuid()->data2,
@@ -182,7 +181,7 @@ QBluetoothUuid::QBluetoothUuid(ProtocolUuid uuid)
}
/*!
- Constructs a new Bluetooth UUID from the service class UUID \a uuid.
+ Constructs a new Bluetooth UUID from the service class \a uuid.
*/
QBluetoothUuid::QBluetoothUuid(ServiceClassUuid uuid)
: QUuid(uuid, baseUuid()->data2, baseUuid()->data3, baseUuid()->data4[0], baseUuid()->data4[1],
@@ -192,7 +191,7 @@ QBluetoothUuid::QBluetoothUuid(ServiceClassUuid uuid)
}
/*!
- Constructs a new Bluetooth UUID from the 16 bit UUID \a uuid.
+ Constructs a new Bluetooth UUID from the 16 bit \a uuid.
*/
QBluetoothUuid::QBluetoothUuid(quint16 uuid)
: QUuid(uuid, baseUuid()->data2, baseUuid()->data3, baseUuid()->data4[0], baseUuid()->data4[1],
@@ -202,7 +201,7 @@ QBluetoothUuid::QBluetoothUuid(quint16 uuid)
}
/*!
- Constructs a new Bluetooth UUID from the 32 bit UUID \a uuid.
+ Constructs a new Bluetooth UUID from the 32 bit \a uuid.
*/
QBluetoothUuid::QBluetoothUuid(quint32 uuid)
: QUuid(uuid, baseUuid()->data2, baseUuid()->data3, baseUuid()->data4[0], baseUuid()->data4[1],
@@ -212,7 +211,7 @@ QBluetoothUuid::QBluetoothUuid(quint32 uuid)
}
/*!
- Constructs a new Bluetooth UUID from the 128 bit UUID \a uuid.
+ Constructs a new Bluetooth UUID from the 128 bit \a uuid.
*/
QBluetoothUuid::QBluetoothUuid(quint128 uuid)
{
@@ -232,7 +231,7 @@ QBluetoothUuid::QBluetoothUuid(quint128 uuid)
}
/*!
- Constructs a new Bluetooth UUID from the string \a uuid.
+ Constructs a new Bluetooth UUID from the \a uuid string.
The string must be in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.
*/
@@ -288,8 +287,8 @@ int QBluetoothUuid::minimumSize() const
}
/*!
- Returns the 16 bit representation of this UUID. If \a ok is passed it is set to true if the
- conversion is possible otherwise it is set to false. The return value is undefined if \a ok is
+ Returns the 16 bit representation of this UUID. If \a ok is passed, it is set to true if the
+ conversion is possible, otherwise it is set to false. The return value is undefined if \a ok is
set to false.
*/
quint16 QBluetoothUuid::toUInt16(bool *ok) const
@@ -309,8 +308,8 @@ quint16 QBluetoothUuid::toUInt16(bool *ok) const
}
/*!
- Returns the 32 bit representation of this UUID. If \a ok is passed it is set to true if the
- conversion is possible otherwise it is set to false. The return value is undefined if \a ok is
+ Returns the 32 bit representation of this UUID. If \a ok is passed, it is set to true if the
+ conversion is possible, otherwise it is set to false. The return value is undefined if \a ok is
set to false.
*/
quint32 QBluetoothUuid::toUInt32(bool *ok) const
@@ -351,7 +350,7 @@ quint128 QBluetoothUuid::toUInt128() const
}
/*!
- Returns true if \a other is equal to this Bluetooth UUID; otherwise returns false.
+ Returns true if \a other is equal to this Bluetooth UUID, otherwise false.
*/
bool QBluetoothUuid::operator==(const QBluetoothUuid &other) const
{
diff --git a/src/bluetooth/ql2capserver.cpp b/src/bluetooth/ql2capserver.cpp
index eaf8f2b2..60492020 100644
--- a/src/bluetooth/ql2capserver.cpp
+++ b/src/bluetooth/ql2capserver.cpp
@@ -54,12 +54,12 @@ QTBLUETOOTH_BEGIN_NAMESPACE
QL2capServer is used to implement Bluetooth services over L2CAP.
- Start listening for incoming connections with listen(). The newConnection() signal is emitted
- when a new connection is established. Call nextPendingConnection() to get a QBluetoothSocket
- for the new connection.
+ Start listening for incoming connections with listen(). Wait till the newConnection() signal
+ is emitted when the connection is established, and call nextPendingConnection() to get a QBluetoothSocket
+ for the connection.
- to enable other devices to find your service create a QBluetoothServiceInfo with the applicable
- attributes for your service and register it with QBluetoothServiceInfo::registerService(). Call
+ To enable other devices to find your service, create a QBluetoothServiceInfo with the applicable
+ attributes for your service and register it using QBluetoothServiceInfo::registerService(). Call
serverPort() to get the L2CAP port number that is being used.
\sa QBluetoothServiceInfo, QBluetoothSocket
@@ -88,7 +88,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE
Start listening for incoming connections to \a address on \a port.
Returns true if the operation succeeded and the L2CAP server is listening for incoming
- connections; otherwise returns false.
+ connections, otherwise returns false.
\sa isListening(), newConnection()
*/
@@ -104,7 +104,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\fn bool QL2capServer::hasPendingConnections() const
- Returns true if a connection is pending; otherwise returns false.
+ Returns true if a connection is pending, otherwise false.
*/
/*!
@@ -123,7 +123,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\fn quint16 QL2capServer::serverPort() const
- Returns the server's port number.
+ Returns the server port number.
*/
/*!
@@ -136,7 +136,7 @@ QL2capServer::QL2capServer(QObject *parent)
}
/*!
- Destorys the L2CAP server.
+ Destroys the L2CAP server.
*/
QL2capServer::~QL2capServer()
{
@@ -144,8 +144,7 @@ QL2capServer::~QL2capServer()
}
/*!
- Returns true if the L2CAP server is listening for incoming connections; otherwise returns
- false.
+ Returns true if the L2CAP server is listening for incoming connections, otherwise false.
*/
bool QL2capServer::isListening() const
{
@@ -167,13 +166,12 @@ int QL2capServer::maxPendingConnections() const
}
/*!
- \fn void QL2capServer::setSecurityFlags(QBluetooth::SecurityFlags security)
- Sets the Bluetooth security flags to \a security. This function must be called prior to calling
- listen().
+ \fn void QL2capServer::setSecurityFlags(QBluetooth::SecurityFlags security)
+ Sets the Bluetooth security flags to \a security. This function must be called before calling listen().
*/
/*!
- \fn QBluetooth::SecurityFlags QL2capServer::securityFlags() const
+ \fn QBluetooth::SecurityFlags QL2capServer::securityFlags() const
Returns the Bluetooth security flags.
*/
diff --git a/src/bluetooth/qrfcommserver.cpp b/src/bluetooth/qrfcommserver.cpp
index fc0440dd..9bb7d2bc 100644
--- a/src/bluetooth/qrfcommserver.cpp
+++ b/src/bluetooth/qrfcommserver.cpp
@@ -54,14 +54,13 @@ QTBLUETOOTH_BEGIN_NAMESPACE
QRfcommServer is used to implement Bluetooth services over RFCOMM.
- Start listening for incoming connections with listen(). The newConnection() signal is emitted
- when a new connection is established. Call nextPendingConnection() to get a QBluetoothSocket
+ Start listening for incoming connections with listen(). Wait till the newConnection() signal
+ is emitted when a new connection is established, and call nextPendingConnection() to get a QBluetoothSocket
for the new connection.
- To enable other devices to find your service create a QBluetoothServiceInfo with the
- applicable attributes for your service and register it with
- QBluetoothServiceInfo::registerService(). Call serverPort() to get the RFCOMM channel number
- that is being used.
+ To enable other devices to find your service, create a QBluetoothServiceInfo with the
+ applicable attributes for your service and register it using QBluetoothServiceInfo::registerService().
+ Call serverPort() to get the RFCOMM channel number that is being used.
\sa QBluetoothServiceInfo, QBluetoothSocket
*/
@@ -89,7 +88,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE
Start listening for incoming connections to \a address on \a port.
Returns true if the operation succeeded and the RFCOMM server is listening for
- incoming connections; otherwise returns false.
+ incoming connections, otherwise returns false.
\sa isListening(), newConnection()
*/
@@ -104,7 +103,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\fn bool QRfcommServer::hasPendingConnections() const
- Returns true if a connection is pending; otherwise returns false.
+ Returns true if a connection is pending, otherwise false.
*/
/*!
@@ -123,7 +122,7 @@ QTBLUETOOTH_BEGIN_NAMESPACE
/*!
\fn quint16 QRfcommServer::serverPort() const
- Returns the server's port number.
+ Returns the server port number.
*/
/*!
@@ -144,8 +143,7 @@ QRfcommServer::~QRfcommServer()
}
/*!
- Returns true if the RFCOMM server is listening for incoming connections; otherwise returns
- false.
+ Returns true if the RFCOMM server is listening for incoming connections, otherwise false.
*/
bool QRfcommServer::isListening() const
{
@@ -167,13 +165,12 @@ int QRfcommServer::maxPendingConnections() const
}
/*!
- \fn QRfcommServer::setSecurityFlags(QBluetooth::SecurityFlags security)
- Sets the Bluetooth security flags to \a security. This function must be called prior to calling
- listen().
+ \fn QRfcommServer::setSecurityFlags(QBluetooth::SecurityFlags security)
+ Sets the Bluetooth security flags to \a security. This function must be called before calling listen().
*/
/*!
- \fn QBluetooth::SecurityFlags QRfcommServer::securityFlags() const
+ \fn QBluetooth::SecurityFlags QRfcommServer::securityFlags() const
Returns the Bluetooth security flags.
*/
diff --git a/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp b/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp
index e501dd6d..6506b753 100644
--- a/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp
+++ b/src/imports/bluetooth/qdeclarativebluetoothdiscoverymodel.cpp
@@ -62,7 +62,7 @@
limited to a single service such as a game.
The model roles provided by BluetoothDiscoveryModel are display, decoration and \c Service.
- Through the \c Service role the BluetoothService maybe accessed for more details.
+ Through the \c Service role the BluetoothService can be accessed for more details.
\sa QBluetoothServiceDiscoveryAgent
@@ -170,9 +170,9 @@ void QDeclarativeBluetoothDiscoveryModel::errorDiscovery(QBluetoothServiceDiscov
/*!
\qmlproperty string BluetoothDiscoveryModel::error
- This property holds the last error reported by discovery.
+ This property holds the last error reported during discovery.
- This property is read only.
+ This property is read-only.
*/
QString QDeclarativeBluetoothDiscoveryModel::error() const
{
@@ -281,8 +281,8 @@ bool QDeclarativeBluetoothDiscoveryModel::discovery()
\qmlproperty string BluetoothDiscoveryModel::uuidFilter
This property holds an optional UUID filter. A UUID can be used to return only
- matching services. 16 bit, 32 bit or 128 bit UUIDs maybe used. The string format
- is the same format as QUuid.
+ matching services. 16 bit, 32 bit or 128 bit UUIDs can be used. The string format
+ is same as the format of QUuid.
\sa QBluetoothUuid
\sa QUuid
diff --git a/src/imports/bluetooth/qdeclarativebluetoothservice.cpp b/src/imports/bluetooth/qdeclarativebluetoothservice.cpp
index 37bffcf3..3b409293 100644
--- a/src/imports/bluetooth/qdeclarativebluetoothservice.cpp
+++ b/src/imports/bluetooth/qdeclarativebluetoothservice.cpp
@@ -143,8 +143,8 @@ QString QDeclarativeBluetoothService::deviceName() const
/*!
\qmlproperty string BluetoothService::deviceAddress
- This property holds the remote device MAc address. Must be valid if you to
- connect to a remote device with a BluetoothSocket.
+ This property holds the remote device's MAC address. Must be a valid address to
+ connect to a remote device using a Bluetooth socket.
*/
QString QDeclarativeBluetoothService::deviceAddress() const
@@ -213,7 +213,7 @@ void QDeclarativeBluetoothService::setServiceDescription(QString description)
/*!
\qmlproperty string BluetoothService::serviceProtocol
- This property holds the protocol used for the service. Can be the string
+ This property holds the protocol used for the service. Can be the string,
"l2cap" or "rfcomm"
*/
@@ -245,9 +245,9 @@ void QDeclarativeBluetoothService::setServiceProtocol(QString protocol)
/*!
\qmlproperty string BluetoothService::serviceUuid
- This property holds the UUID of the remote service. Service UUID or port, as
- well as the address must be set to connect to a remote service. If UUID and
- port are set, the port is used. The UUID takes longer to connect since
+ This property holds the UUID of the remote service. Service UUID or port,
+ and the address must be set to connect to a remote service. If UUID and
+ port are set, the port is used. The UUID takes longer to connect as
service discovery must be initiated to discover the port value.
*/
@@ -277,7 +277,7 @@ void QDeclarativeBluetoothService::setServiceUuid(QString uuid)
This property holds the port value for the remote service. Bluetooth does not
use well defined port values, so port values should not be stored and used
- later without care. Connecting via UUID is much more consistent.
+ later. Connecting using UUID is much more consistent.
*/
qint32 QDeclarativeBluetoothService::servicePort() const
{
@@ -308,8 +308,8 @@ void QDeclarativeBluetoothService::setServicePort(qint32 port)
/*!
\qmlproperty string BluetoothService::registered
- This property holds the registration/publication status of the service. If true the service
- is published via service discovery. Not implemented in 1.2.
+ This property holds the registration/publication status of the service. If true, the service
+ is published during service discovery. Not implemented in 1.2.
*/
bool QDeclarativeBluetoothService::isRegistered() const
diff --git a/src/imports/bluetooth/qdeclarativebluetoothsocket.cpp b/src/imports/bluetooth/qdeclarativebluetoothsocket.cpp
index 4fa683e6..10315ebc 100644
--- a/src/imports/bluetooth/qdeclarativebluetoothsocket.cpp
+++ b/src/imports/bluetooth/qdeclarativebluetoothsocket.cpp
@@ -67,12 +67,12 @@
The BluetoothSocket element was introduced in \bold{QtBluetooth 5.0}.
- It allows a QML class easily connect to another bluetooth device and send
- and received QString's from the device. Data is sent and received via a
- QDataStream allowing type safe transfer of string data. QDataStream is a well known
- format and maybe decoded by non-Qt applications.
+ It allows a QML class connect to another bluetooth device and send
+ and receive QString from the device. Data is sent and received using a
+ QDataStream object allowing type safe transfer of string data. QDataStream
+ is a well known format and can be decoded by non-Qt applications.
- Connections to remove devices can be over rfcomm or l2cap. Either the remote port
+ Connections to remote devices can be over rfcomm or l2cap. Either the remote port
or service UUID is required. This is specified by creating a BluetoothService,
or passing in the service return from BluetoothDiscoveryModel.
*/
@@ -176,7 +176,7 @@ void QDeclarativeBluetoothSocket::componentComplete()
/*!
\qmlproperty BluetoothService BluetoothSocket::service
- This property holds the details of the remote service to connect too. It can be
+ This property holds the details of the remote service to connect to. It can be
set to a static BluetoothService with a fixed description, or a service returned
by service discovery.
*/
@@ -203,8 +203,8 @@ void QDeclarativeBluetoothSocket::setService(QDeclarativeBluetoothService *servi
\qmlproperty bool BluetoothSocket::connected
This property holds the connection state of the socket. If the socket is
- connected to peer it returns true. It can be set true of false to control the
- connection. When set true the property will not return true until the
+ connected to peer, it returns true. It can be set true or false to control the
+ connection. When set to true, the property will not return true until the
connection is established.
*/
@@ -239,7 +239,7 @@ void QDeclarativeBluetoothSocket::setConnected(bool connected)
\qmlproperty string BluetoothSocket::error
This property holds the string for the last reported error
- This property is read only.
+ This property is read-only.
*/
@@ -319,9 +319,9 @@ void QDeclarativeBluetoothSocket::socket_readyRead()
\qmlproperty string BluetoothSocket::stringData
This property receives or sends data to remote bluetooth device. Arrival of
- data is signaled through the dataAvailable signal and can be read by
- stringData. Calling sendStringData will transmit the string to the far side.
- If excessive amounts of data are sent the function may block. Reading will
+ data is signaled by the dataAvailable signal and can be read by
+ stringData. Calling sendStringData will transmit the string.
+ If excessive amounts of data are sent, the function may block sending. Reading will
never block.
*/