Create separate Border Router doxygen module. (#1930)

Also some minor doxygen fixup for public APIs.
This commit is contained in:
Jonathan Hui
2017-06-23 06:20:59 -07:00
committed by GitHub
parent f02a05ea9b
commit c05a723f70
5 changed files with 11 additions and 4 deletions
+1 -1
View File
@@ -42,7 +42,7 @@ extern "C" {
#endif
/**
* @addtogroup api-thread-general
* @addtogroup api-border-router
*
* @{
*
+6
View File
@@ -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 <openthread-config-generic.h>
#endif
+1 -1
View File
@@ -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).
+2 -1
View File
@@ -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
*
* @}
*
+1 -1
View File
@@ -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);