From c05a723f70cdad4f8aa8fe8664032c7b1b033988 Mon Sep 17 00:00:00 2001 From: Jonathan Hui Date: Fri, 23 Jun 2017 06:20:59 -0700 Subject: [PATCH] Create separate Border Router doxygen module. (#1930) Also some minor doxygen fixup for public APIs. --- include/openthread/border_router.h | 2 +- include/openthread/config.h | 6 ++++++ include/openthread/ncp.h | 2 +- include/openthread/openthread.h | 3 ++- include/openthread/thread.h | 2 +- 5 files changed, 11 insertions(+), 4 deletions(-) diff --git a/include/openthread/border_router.h b/include/openthread/border_router.h index 27a90c72b..37871f80b 100644 --- a/include/openthread/border_router.h +++ b/include/openthread/border_router.h @@ -42,7 +42,7 @@ extern "C" { #endif /** - * @addtogroup api-thread-general + * @addtogroup api-border-router * * @{ * diff --git a/include/openthread/config.h b/include/openthread/config.h index d3247e028..1267e6407 100644 --- a/include/openthread/config.h +++ b/include/openthread/config.h @@ -35,6 +35,12 @@ #ifndef OPENTHREAD_CONFIG_H_ #define OPENTHREAD_CONFIG_H_ +/** + * @def OPENTHREAD_CONFIG_FILE + * + * The OpenThread feature configuration file. + * + */ #if !defined(OPENTHREAD_CONFIG_FILE) #define OPENTHREAD_CONFIG_FILE #endif diff --git a/include/openthread/ncp.h b/include/openthread/ncp.h index 160737bf5..2cd1d4a35 100644 --- a/include/openthread/ncp.h +++ b/include/openthread/ncp.h @@ -107,7 +107,7 @@ typedef bool (*otNcpDelegateAllowPeekPoke)(uint32_t aAddress, uint16_t aCount); * If the delegate pointer is set to NULL, it allows peek/poke operation for any address. * * @param[in] aAllowPeekDelegate Delegate function pointer for peek operation. - * @param[in] aAllowPeekDelegate Delegate function pointer for poke operation. + * @param[in] aAllowPokeDelegate Delegate function pointer for poke operation. * * @retval OT_ERROR_NONE Successfully registered delegate functions. * @retval OT_ERROR_DISABLED_FEATURE Peek/Poke feature is disabled (by a build-time configuration option). diff --git a/include/openthread/openthread.h b/include/openthread/openthread.h index 0d267de70..2c0e8eae8 100644 --- a/include/openthread/openthread.h +++ b/include/openthread/openthread.h @@ -93,13 +93,14 @@ extern "C" { * * @{ * - * @defgroup api-tmf-proxy TMF Proxy + * @defgroup api-border-router Border Router * @defgroup api-commissioner Commissioner * @defgroup api-thread-general General * @brief This module includes functions for all Thread roles. * @defgroup api-joiner Joiner * @defgroup api-thread-router Router/Leader * @brief This module includes functions for Thread Routers and Leaders. + * @defgroup api-tmf-proxy TMF Proxy * * @} * diff --git a/include/openthread/thread.h b/include/openthread/thread.h index e013be199..4769c7235 100644 --- a/include/openthread/thread.h +++ b/include/openthread/thread.h @@ -112,7 +112,7 @@ OTAPI bool OTCALL otThreadIsSingleton(otInstance *aInstance); * @retval OT_ERROR_BUSY Already performing an Thread Discovery. * */ -OTAPI otError OTCALL otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanid, bool aJoiner, +OTAPI otError OTCALL otThreadDiscover(otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext);