mirror of
https://github.com/espressif/openthread.git
synced 2026-08-20 01:19:51 +00:00
[docs] Doxygen tag updates (#3496)
This commit is contained in:
committed by
Jonathan Hui
parent
0cc913b6b5
commit
4bc819c307
@@ -99,7 +99,7 @@ otError otCoapSecureStop(otInstance *aInstance);
|
||||
* DTLS_PSK_WITH_AES_128_CCM_8.
|
||||
*
|
||||
* @param[in] aInstance A pointer to an OpenThread instance.
|
||||
* @param[in] aPSK A pointer to the PSK.
|
||||
* @param[in] aPsk A pointer to the PSK.
|
||||
* @param[in] aPskLength The PSK length.
|
||||
* @param[in] aPskIdentity The Identity Name for the PSK.
|
||||
* @param[in] aPskIdLength The PSK Identity Length.
|
||||
@@ -150,7 +150,7 @@ void otCoapSecureSetSslAuthMode(otInstance *aInstance, bool aVerifyPeerCertifica
|
||||
* DTLS session with DTLS_ECDHE_ECDSA_WITH_AES_128_CCM_8.
|
||||
*
|
||||
* @param[in] aInstance A pointer to an OpenThread instance.
|
||||
* @param[in] aX509Certificate A pointer to the PEM formatted X509 certificate.
|
||||
* @param[in] aX509Cert A pointer to the PEM formatted X509 certificate.
|
||||
* @param[in] aX509Length The length of certificate.
|
||||
* @param[in] aPrivateKey A pointer to the PEM formatted private key.
|
||||
* @param[in] aPrivateKeyLength The length of the private key.
|
||||
@@ -189,7 +189,7 @@ otError otCoapSecureSetCaCertificateChain(otInstance * aInstance,
|
||||
*
|
||||
* @param[in] aInstance A pointer to an OpenThread instance.
|
||||
* @param[in] aSockAddr A pointer to the remote sockaddr.
|
||||
* @param[in] aCallback A pointer to a function that will be called when the DTLS connection
|
||||
* @param[in] aHandler A pointer to a function that will be called when the DTLS connection
|
||||
* state changes.
|
||||
* @param[in] aContext A pointer to arbitrary context information.
|
||||
*
|
||||
@@ -291,8 +291,8 @@ void otCoapSecureSetDefaultHandler(otInstance *aInstance, otCoapRequestHandler a
|
||||
* a Client connect to the CoAP Secure server.
|
||||
*
|
||||
* @param[in] aInstance A pointer to an OpenThread instance.
|
||||
* @param[in] aMessageInfo A pointer to a message info structure.
|
||||
* @param[in] aHandler A pointer to a function that will be called once DTLS connection is established.
|
||||
* @param[in] aContext A pointer to arbitrary context information. May be NULL if not used.
|
||||
*
|
||||
*/
|
||||
void otCoapSecureSetClientConnectedCallback(otInstance * aInstance,
|
||||
|
||||
@@ -62,8 +62,6 @@ extern "C" {
|
||||
* @defgroup api-net IPv6 Networking
|
||||
* @{
|
||||
*
|
||||
* @defgroup api-dhcp6 DHCPv6
|
||||
* @brief This module includes functions for DHCPv6 Client and Server.
|
||||
* @defgroup api-dns DNSv6
|
||||
* @defgroup api-icmp6 ICMPv6
|
||||
* @defgroup api-ip6 IPv6
|
||||
|
||||
@@ -593,6 +593,7 @@ bool otIp6IsAddressUnspecified(const otIp6Address *aAddress);
|
||||
/**
|
||||
* This function perform OpenThread source address selection.
|
||||
*
|
||||
* @param[in] aInstance A pointer to an OpenThread instance.
|
||||
* @param[inout] aMessageInfo A pointer to the message information.
|
||||
*
|
||||
* @retval OT_ERROR_NONE Found a source address and is filled into mSockAddr of @p aMessageInfo.
|
||||
|
||||
@@ -63,6 +63,10 @@ typedef enum otNetworkTimeStatus
|
||||
OT_NETWORK_TIME_SYNCHRONIZED = 1, ///< The device network time is synchronized.
|
||||
} otNetworkTimeStatus;
|
||||
|
||||
/**
|
||||
* This function pointer is called when a network time sync or status change occurs.
|
||||
*
|
||||
*/
|
||||
typedef void (*otNetworkTimeSyncCallbackFn)(void *aCallbackContext);
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user