mirror of
https://github.com/espressif/openthread.git
synced 2026-08-16 07:37:47 +00:00
[infra-if] fix documentation group order (#12823)
This commit moves the `@addtogroup plat-infra-if` Doxygen block to the top of the `infra_if.h` header file. Previously, it was defined after `otPlatInfraIfLinkLayerAddress`, causing that structure and the `OT_PLAT_INFRA_IF_MAX_LINK_LAYER_ADDR_LENGTH` macro to be excluded from the `plat-infra-if` module in the generated documentation.
This commit is contained in:
@@ -52,7 +52,7 @@ extern "C" {
|
||||
*
|
||||
* @note This number versions both OpenThread platform and user APIs.
|
||||
*/
|
||||
#define OPENTHREAD_API_VERSION (587)
|
||||
#define OPENTHREAD_API_VERSION (588)
|
||||
|
||||
/**
|
||||
* @addtogroup api-instance
|
||||
|
||||
@@ -47,6 +47,15 @@
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @addtogroup plat-infra-if
|
||||
*
|
||||
* @brief
|
||||
* This module includes the platform abstraction for the adjacent infrastructure network interface.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#define OT_PLAT_INFRA_IF_MAX_LINK_LAYER_ADDR_LENGTH 16 ///< Maximum InfraIf Link-layer address length.
|
||||
|
||||
/**
|
||||
@@ -58,15 +67,6 @@ typedef struct otPlatInfraIfLinkLayerAddress
|
||||
uint8_t mLength; ///< The address length (number of bytes).
|
||||
} otPlatInfraIfLinkLayerAddress;
|
||||
|
||||
/**
|
||||
* @addtogroup plat-infra-if
|
||||
*
|
||||
* @brief
|
||||
* This module includes the platform abstraction for the adjacent infrastructure network interface.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* Tells whether an infra interface has the given IPv6 address assigned.
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user