[docs] reference groups added and typos fixed (#9709)

This commit is contained in:
jrhodie
2023-12-13 12:18:40 -08:00
committed by GitHub
parent de67820c3c
commit 266a97b80a
5 changed files with 7 additions and 5 deletions
+2
View File
@@ -53,6 +53,7 @@
* @defgroup api-net IPv6 Networking
* @{
*
* @defgroup api-ble-secure BLE Secure
* @defgroup api-dns DNS
* @defgroup api-dnssd-server DNS-SD Server
* @defgroup api-icmp6 ICMPv6
@@ -168,6 +169,7 @@
* @{
*
* @defgroup plat-alarm Alarm
* @defgroup plat-ble BLE
* @defgroup plat-crypto Crypto - Platform
* @defgroup plat-dns DNS - Platform
* @defgroup plat-entropy Entropy
+1 -1
View File
@@ -124,7 +124,7 @@ typedef struct otBorderRoutingPrefixTableEntry
*/
typedef struct otPdProcessedRaInfo
{
uint32_t mNumPlatformRaReceived; ///< The number of platform generated RA handled by ProcessPlatfromGeneratedRa.
uint32_t mNumPlatformRaReceived; ///< The number of platform generated RA handled by ProcessPlatformGeneratedRa.
uint32_t mNumPlatformPioProcessed; ///< The number of PIO processed for adding OMR prefixes.
uint32_t mLastPlatformRaMsec; ///< The timestamp of last processed RA message.
} otPdProcessedRaInfo;
+1 -1
View File
@@ -53,7 +53,7 @@ extern "C" {
* @note This number versions both OpenThread platform and user APIs.
*
*/
#define OPENTHREAD_API_VERSION (383)
#define OPENTHREAD_API_VERSION (384)
/**
* @addtogroup api-instance
+1 -1
View File
@@ -3760,7 +3760,7 @@ exit:
extern "C" void otPlatBorderRoutingProcessIcmp6Ra(otInstance *aInstance, const uint8_t *aMessage, uint16_t aLength)
{
AsCoreType(aInstance).Get<BorderRouter::RoutingManager>().ProcessPlatfromGeneratedRa(aMessage, aLength);
AsCoreType(aInstance).Get<BorderRouter::RoutingManager>().ProcessPlatformGeneratedRa(aMessage, aLength);
}
#endif // OPENTHREAD_CONFIG_BORDER_ROUTING_DHCP6_PD_ENABLE
+2 -2
View File
@@ -283,7 +283,7 @@ public:
/**
* Returns the platform provided off-mesh-routable (OMR) prefix.
*
* The prefix is extracted from the platform generated RA messages handled by `ProcessPlatfromGeneratedNd()`.
* The prefix is extracted from the platform generated RA messages handled by `ProcessPlatformGeneratedNd()`.
*
* @param[out] aPrefixInfo A reference to where the prefix info will be output to.
*
@@ -517,7 +517,7 @@ public:
* @param[in] aLength The length of the router advertisement message.
*
*/
void ProcessPlatfromGeneratedRa(const uint8_t *aRouterAdvert, uint16_t aLength)
void ProcessPlatformGeneratedRa(const uint8_t *aRouterAdvert, uint16_t aLength)
{
mPdPrefixManager.ProcessPlatformGeneratedRa(aRouterAdvert, aLength);
}