From 02ebea91bcf0e212b3226a761a491625f671e73b Mon Sep 17 00:00:00 2001 From: Alex Blasche Date: Wed, 10 Feb 2016 10:47:58 +0100 Subject: Improve BTLE documentation Fixes a few qdoc warnings and improves the available content. Change-Id: I286cfdeb85d3be2d100e00150efedf7645096f69 Reviewed-by: Christian Kandeler --- src/bluetooth/qlowenergycontroller.cpp | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'src/bluetooth/qlowenergycontroller.cpp') 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 */ -- cgit v1.2.3