From be7cc41da4367c54a944fe3ea45c184e398fbf35 Mon Sep 17 00:00:00 2001
From: Vincent Coubard <vincent.coubard@arm.com>
Date: Sun, 25 Nov 2018 13:48:26 +0000
Subject: [PATCH] BLE: doxygen fixes.

---
 features/FEATURE_BLE/ble/BLETypes.h                   | 4 ++++
 features/FEATURE_BLE/ble/gap/AdvertisingDataBuilder.h | 8 ++++++--
 features/FEATURE_BLE/ble/gap/AdvertisingParameters.h  | 6 +++---
 3 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/features/FEATURE_BLE/ble/BLETypes.h b/features/FEATURE_BLE/ble/BLETypes.h
index 2261ec2756..55cead261d 100644
--- a/features/FEATURE_BLE/ble/BLETypes.h
+++ b/features/FEATURE_BLE/ble/BLETypes.h
@@ -321,6 +321,10 @@ void set_all_zeros(byte_array_class &byte_array) {
     memset(&byte_array[0], 0x00, byte_array.size());
 }
 
+/**
+ * Model fixed size array values.
+ * @tparam array_size The size of the array.
+ */
 template <size_t array_size>
 struct byte_array_t {
     /**
diff --git a/features/FEATURE_BLE/ble/gap/AdvertisingDataBuilder.h b/features/FEATURE_BLE/ble/gap/AdvertisingDataBuilder.h
index a08590dfce..a7ce3ccdbe 100644
--- a/features/FEATURE_BLE/ble/gap/AdvertisingDataBuilder.h
+++ b/features/FEATURE_BLE/ble/gap/AdvertisingDataBuilder.h
@@ -539,7 +539,12 @@ struct adv_data_appearance_t : SafeEnum<adv_data_appearance_t, uint16_t> {
     }
 };
 
-
+/**
+ * Build advertising data.
+ *
+ * The builder accept an array of bytes in input and returns the result of the
+ * construction with getAdvertisingData().
+ */
 class AdvertisingDataBuilder {
 public:
     /** Advertising data needs a user provided buffer to store the data.
@@ -774,7 +779,6 @@ public:
      *
      * @param[in] service UUID of the service.
      * @param[in] data New data to be added.
-     * @param[in] complete True if this is a complete list.
      *
      * @retval BLE_ERROR_NONE on success.
      * @retval BLE_ERROR_BUFFER_OVERFLOW if buffer is too small to contain the new data.
diff --git a/features/FEATURE_BLE/ble/gap/AdvertisingParameters.h b/features/FEATURE_BLE/ble/gap/AdvertisingParameters.h
index 6ed73e7cb5..2598e851bb 100644
--- a/features/FEATURE_BLE/ble/gap/AdvertisingParameters.h
+++ b/features/FEATURE_BLE/ble/gap/AdvertisingParameters.h
@@ -184,7 +184,7 @@ public:
 
     /** Set the advertising intervals on the primary channels.
      *
-     * @param[in] minInterval, maxInterval Time interval between two advertisement.
+     * @param[in] min, max Time interval between two advertisement.
      * A range is provided to the LE subsystem so it can adjust the advertising
      * interval with other transmission happening on the BLE radio.
      *
@@ -325,7 +325,7 @@ public:
 
     /** Set the filter policy of whitelist use during advertising;
      *
-     * @param Policy to use.
+     * @param mode Policy to use.
      *
      * @return A reference to this object.
      */
@@ -427,7 +427,7 @@ public:
      *
      * @return A reference to this object.
      *
-     * @see ::ble::Gap::EventHandler::onScanRequest()
+     * @see ::ble::Gap::EventHandler::onScanRequestReceived()
      */
     AdvertisingParameters &setScanRequestNotification(bool enable = true)
     {