Improve BTLE documentation

Fixes a few qdoc warnings and improves the available content.

Change-Id: I286cfdeb85d3be2d100e00150efedf7645096f69
Reviewed-by: Christian Kandeler <christian.kandeler@theqtcompany.com>

3 files changed, 30 insertions, 7 deletions

diff --git a/src/bluetooth/qlowenergyadvertisingparameters.cpp b/src/bluetooth/qlowenergyadvertisingparameters.cpp
index 9b1a283e..46a09c05 100644
--- a/src/bluetooth/qlowenergyadvertisingparameters.cpp
+++ b/src/bluetooth/qlowenergyadvertisingparameters.cpp
@@ -115,9 +115,18 @@ public:
 */
 
 /*!
-    \struct QLowEnergyAdvertisingParameters::AddressInfo
+    \class QLowEnergyAdvertisingParameters::AddressInfo
+    \inmodule QtBluetooth
+    \since 5.7
+
+    \brief The QLowEnergyAdvertisingParameters::AddressInfo defines the elements of a white list.
+
+    A list of QLowEnergyAdvertisingParameters::AddressInfo instances is passed to
+    \l QLowEnergyAdvertisingParameters::setWhiteList(). White lists are used to
+    restrict the devices which have the permission to interact with the peripheral.
+    The permitted type of interaction is defined by
+    \l QLowEnergyAdvertisingParameters::FilterPolicy.
 
-    Objects of this type form the elements of a white list.
     \sa QLowEnergyAdvertisingParameters::whiteList()
 */
 
@@ -131,6 +140,18 @@ public:
         The type of the address (public or private).
 */
 
+/*!
+    \fn QLowEnergyAdvertisingParameters::AddressInfo::AddressInfo(const QBluetoothAddress &addr, QLowEnergyController::RemoteAddressType type)
+
+    Constructs a new AddressInfo instance. \a addr represents the Bluetooth address of
+    the remote device and \a type the nature of the address.
+*/
+
+/*!
+    \fn QLowEnergyAdvertisingParameters::AddressInfo::AddressInfo()
+
+    Constructs a default constructed AddressInfo instance.
+*/
 
 /*!
    Constructs a new object of this class. All values are initialized to their defaults
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
  */
diff --git a/src/bluetooth/qlowenergydescriptordata.cpp b/src/bluetooth/qlowenergydescriptordata.cpp
index 3ac73ff6..f5836cdc 100644
--- a/src/bluetooth/qlowenergydescriptordata.cpp
+++ b/src/bluetooth/qlowenergydescriptordata.cpp
@@ -116,8 +116,8 @@ QByteArray QLowEnergyDescriptorData::value() const
 }
 
 /*!
-  Sets the value of this descriptor. It will be sent to a peer device exactly the way it is
-  provided here, so callers need to take care of things such as endianness.
+  Sets the value of this descriptor to \a value. It will be sent to a peer device
+  exactly the way it is provided here, so callers need to take care of things such as endianness.
  */
 void QLowEnergyDescriptorData::setValue(const QByteArray &value)
 {