diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2018-09-28 15:23:47 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2018-10-15 06:41:34 +0000 |
commit | 261e4c619214af5e5cf95ec08a7d46d702ae0a93 (patch) | |
tree | b670a6f347a8a8053bee850162c6ed542fcb5524 /src/bluetoothsettings/bluetoothdevice.cpp | |
parent | 0ecd391912f6338d5aef6105600fc8c321c83bd8 (diff) |
Doc: Add documentation for C++ classes
Currently, only QML types are documented.
Task-number: QTBUG-69686
Change-Id: Idc13bff25a154e88c6c769c0af37204573ec1118
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Teemu Holappa <teemu.holappa@qt.io>
Diffstat (limited to 'src/bluetoothsettings/bluetoothdevice.cpp')
-rw-r--r-- | src/bluetoothsettings/bluetoothdevice.cpp | 70 |
1 files changed, 69 insertions, 1 deletions
diff --git a/src/bluetoothsettings/bluetoothdevice.cpp b/src/bluetoothsettings/bluetoothdevice.cpp index 442a31c..01de4bc 100644 --- a/src/bluetoothsettings/bluetoothdevice.cpp +++ b/src/bluetoothsettings/bluetoothdevice.cpp @@ -32,60 +32,128 @@ QT_BEGIN_NAMESPACE +/*! + \class BluetoothDevice + \inmodule QtDeviceUtilities + + \brief The BluetoothDevice class controls Bluetooth settings. + + The Bluetooth settings contain information about the local Bluetooth device, + such as the device model and whether the device is powered on and available + for connections with other Bluetooth devices. + + The Bluetooth device can scan for other Bluetooth devices in range and + retrieve information about them. The Bluetooth device then uses the address + of another device to attempt pairing to it, and connects to it if the + pairing was successful. +*/ + +/*! + \property BluetoothDevice::scanning + \brief Whether the Bluetooth device is scanning for remote devices. +*/ + +/*! + \property BluetoothDevice::powered + \brief Whether the power in the Bluetooth device is on or off. +*/ + +/*! + \property BluetoothDevice::available + \brief Whether the Bluetooth device is available. +*/ + +/*! + \property BluetoothDevice::deviceModel + \brief The model of the Bluetooth device. +*/ + +/*! + Creates a new Bluetooth device with the parent \a parent. +*/ BluetoothDevice::BluetoothDevice(QObject *parent) : QObject(parent) ,d_ptr(new BluetoothDevicePrivate(this)) { } +/*! + Returns \c true if the power is switched on in the Bluetooth device. +*/ bool BluetoothDevice::powered() const { Q_D(const BluetoothDevice); return d->powered(); } +/*! + Sets the powered state in the Bluetooth device to \a aPowered. +*/ void BluetoothDevice::setPowered(const bool& aPowered) { Q_D(BluetoothDevice); d->setPowered(aPowered); } - +/*! + Returns the model of the Bluetooth device. +*/ DiscoveryModel* BluetoothDevice::deviceModel() const { Q_D(const BluetoothDevice); return d->deviceModel(); } +/*! + Returns whether the Bluetooth device is scanning for remote devices. +*/ bool BluetoothDevice::scanning() const { Q_D(const BluetoothDevice); return d->scanning(); } +/*! + Sets scanning in the Bluetooth device to \a aScan. +*/ void BluetoothDevice::setScanning(const bool& aScan) { Q_D(BluetoothDevice); d->setScanning(aScan); } +/*! + Starts the process of pairing to a remote device specified by \a address, + and connects to it if the pairing was successful. + + \sa requestConnect +*/ void BluetoothDevice::requestPairing(const QString& address) { Q_D(BluetoothDevice); d->requestPairing(address); } +/*! + Connects to the remote device specified by \a address. +*/ void BluetoothDevice::requestConnect(const QString& address) { Q_D(BluetoothDevice); d->requestConnect(address); } +/*! + Disconnects from the remote device specified by \a address. +*/ void BluetoothDevice::requestDisconnect(const QString& address) { Q_D(BluetoothDevice); d->requestDisconnect(address); } +/*! + Returns the availability of the Bluetooth device. +*/ bool BluetoothDevice::available() const { Q_D(const BluetoothDevice); |