diff options
| author | Alex Blasche <alexander.blasche@theqtcompany.com> | 2016-02-10 10:47:58 +0100 |
|---|---|---|
| committer | Alex Blasche <alexander.blasche@theqtcompany.com> | 2016-02-10 12:57:36 +0000 |
| commit | 02ebea91bcf0e212b3226a761a491625f671e73b (patch) | |
| tree | 00b5ef806b6545cf65636ad2cda5176474da782f /src/bluetooth/qlowenergycontroller.cpp | |
| parent | 547c931904e5251fe79413ba933506a88df0fbbb (diff) | |
Improve BTLE documentation
Fixes a few qdoc warnings and improves the available content.
Change-Id: I286cfdeb85d3be2d100e00150efedf7645096f69
Reviewed-by: Christian Kandeler <christian.kandeler@theqtcompany.com>
Diffstat (limited to 'src/bluetooth/qlowenergycontroller.cpp')
| -rw-r--r-- | src/bluetooth/qlowenergycontroller.cpp | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/bluetooth/qlowenergycontroller.cpp b/src/bluetooth/qlowenergycontroller.cpp index 238ed92d..838bbd0d 100644 --- a/src/bluetooth/qlowenergycontroller.cpp +++ b/src/bluetooth/qlowenergycontroller.cpp @@ -544,7 +544,8 @@ QLowEnergyController::QLowEnergyController( } /*! - Returns a new object of this class that is in the \l CentralRole. + Returns a new object of this class that is in the \l CentralRole and has the + parent object \a parent. The \a remoteDevice refers to the device that a connection will be established to later. * The controller uses the local default Bluetooth adapter for the connection management. @@ -558,9 +559,10 @@ QLowEnergyController *QLowEnergyController::createCentral(const QBluetoothDevice /*! - Returns a new object of this class that is in the \l PeripheralRole. + Returns a new object of this class that is in the \l PeripheralRole and has the + parent object \a parent. Typically, the next step is to call \l startAdvertising() on the returned object. - * + The controller uses the local default Bluetooth adapter for the connection management. \sa QLowEnergyController::PeripheralRole */ |