From 13667b0499441bc4207d08487890daabffd4c804 Mon Sep 17 00:00:00 2001 From: Jeff Bumgardner Date: Mon, 11 Jun 2018 13:07:14 -0700 Subject: [PATCH] [docs] updating Doxygen tags for ble module (#2777) --- include/openthread/openthread.h | 1 + include/openthread/platform/ble.h | 9 +++++---- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/include/openthread/openthread.h b/include/openthread/openthread.h index 80ba37c52..4d2b946b3 100644 --- a/include/openthread/openthread.h +++ b/include/openthread/openthread.h @@ -135,6 +135,7 @@ extern "C" { * @{ * * @defgroup plat-alarm Alarm + * @defgroup plat-ble BLE Host * @defgroup plat-factory-diagnostics Factory Diagnostics * @defgroup plat-logging Logging * @defgroup plat-memory Memory diff --git a/include/openthread/platform/ble.h b/include/openthread/platform/ble.h index 0c3ac0db3..0d14450ee 100644 --- a/include/openthread/platform/ble.h +++ b/include/openthread/platform/ble.h @@ -28,7 +28,9 @@ /** * @file + * @brief * This file defines a generic OpenThread BLE driver HOST interface. + * */ #ifndef OT_PLATFORM_BLE_H_ @@ -43,8 +45,7 @@ extern "C" { #include /** - * @defgroup ble BLE Host - * @ingroup platform + * @addtogroup plat-ble * * @brief * This module includes the platform abstraction for BLE Host communication. @@ -850,10 +851,10 @@ otError otPlatBleGattClientCharacteristicsDiscover(otInstance *aInstance, uint16 * The BLE driver calls this method to notify OpenThread that GATT Characteristic * Discovery of a service has been done. * - * @note This function shall be used only for GATT Client. - * * In case of success, all elements inside @p aChars should have a valid mHandleValue value. * + * @note This function shall be used only for GATT Client. + * * @param[in] aInstance The OpenThread instance structure. * @param[in] aChars A pointer to discovered characteristic list. * @param[in] aCount Number of characteristics in @p aChar list.