mirror of
https://github.com/espressif/openthread.git
synced 2026-08-04 09:57:47 +00:00
[docs] use NULL in place of nullptr (#11435)
This commit is contained in:
@@ -328,7 +328,7 @@ typedef enum
|
||||
*
|
||||
* @param[in] aContext The user context pointer.
|
||||
* @param[in] aEvent The ND Proxy event.
|
||||
* @param[in] aDua The Domain Unicast Address of the ND Proxy, or `nullptr` if @p aEvent is
|
||||
* @param[in] aDua The Domain Unicast Address of the ND Proxy, or NULL if @p aEvent is
|
||||
* `OT_BACKBONE_ROUTER_NDPROXY_CLEARED`.
|
||||
*/
|
||||
typedef void (*otBackboneRouterNdProxyCallback)(void *aContext,
|
||||
@@ -385,7 +385,7 @@ typedef enum
|
||||
*
|
||||
* @param[in] aContext The user context pointer.
|
||||
* @param[in] aEvent The Domain Prefix event.
|
||||
* @param[in] aDomainPrefix The new Domain Prefix if added or changed, nullptr otherwise.
|
||||
* @param[in] aDomainPrefix The new Domain Prefix if added or changed, NULL otherwise.
|
||||
*/
|
||||
typedef void (*otBackboneRouterDomainPrefixCallback)(void *aContext,
|
||||
otBackboneRouterDomainPrefixEvent aEvent,
|
||||
|
||||
@@ -52,7 +52,7 @@ extern "C" {
|
||||
*
|
||||
* @note This number versions both OpenThread platform and user APIs.
|
||||
*/
|
||||
#define OPENTHREAD_API_VERSION (499)
|
||||
#define OPENTHREAD_API_VERSION (500)
|
||||
|
||||
/**
|
||||
* @addtogroup api-instance
|
||||
|
||||
@@ -1102,7 +1102,7 @@ otError otLinkSetRegion(otInstance *aInstance, uint16_t aRegionCode);
|
||||
* @param[out] aRegionCode The radio region code. The `aRegionCode >> 8` is first ascii char
|
||||
* and the `aRegionCode & 0xff` is the second ascii char.
|
||||
*
|
||||
* @retval OT_ERROR_INVALID_ARGS @p aRegionCode is nullptr.
|
||||
* @retval OT_ERROR_INVALID_ARGS @p aRegionCode is NULL.
|
||||
* @retval OT_ERROR_FAILED Other platform specific errors.
|
||||
* @retval OT_ERROR_NONE Successfully got region code.
|
||||
* @retval OT_ERROR_NOT_IMPLEMENTED The feature is not implemented.
|
||||
|
||||
@@ -446,7 +446,7 @@ void otIp4ToIp4MappedIp6Address(const otIp4Address *aIp4Address, otIp6Address *a
|
||||
* truncated but the outputted string is always null-terminated.
|
||||
*
|
||||
* @param[in] aAddress A pointer to an IPv4 address (MUST NOT be NULL).
|
||||
* @param[out] aBuffer A pointer to a char array to output the string (MUST NOT be `nullptr`).
|
||||
* @param[out] aBuffer A pointer to a char array to output the string (MUST NOT be NULL).
|
||||
* @param[in] aSize The size of @p aBuffer (in bytes).
|
||||
*/
|
||||
void otIp4AddressToString(const otIp4Address *aAddress, char *aBuffer, uint16_t aSize);
|
||||
@@ -474,7 +474,7 @@ otError otIp4CidrFromString(const char *aString, otIp4Cidr *aCidr);
|
||||
* truncated but the outputted string is always null-terminated.
|
||||
*
|
||||
* @param[in] aCidr A pointer to an IPv4 CIDR (MUST NOT be NULL).
|
||||
* @param[out] aBuffer A pointer to a char array to output the string (MUST NOT be `nullptr`).
|
||||
* @param[out] aBuffer A pointer to a char array to output the string (MUST NOT be NULL).
|
||||
* @param[in] aSize The size of @p aBuffer (in bytes).
|
||||
*/
|
||||
void otIp4CidrToString(const otIp4Cidr *aCidr, char *aBuffer, uint16_t aSize);
|
||||
|
||||
@@ -87,11 +87,11 @@ void otPlatDnsCancelUpstreamQuery(otInstance *aInstance, otPlatDnsUpstreamQuery
|
||||
* The transaction will be released, so the platform must not call on the same transaction twice. This function passes
|
||||
* the ownership of `aResponse` to OpenThread stack.
|
||||
*
|
||||
* Platform can pass a nullptr to close a transaction without a response.
|
||||
* Platform can pass NULL to close a transaction without a response.
|
||||
*
|
||||
* @param[in] aInstance The OpenThread instance structure.
|
||||
* @param[in] aTxn A pointer to the opaque DNS query transaction object.
|
||||
* @param[in] aResponse A message buffer of the DNS response payload or `nullptr` to close a transaction without a
|
||||
* @param[in] aResponse A message buffer of the DNS response payload or NULL to close a transaction without a
|
||||
* response.
|
||||
*/
|
||||
extern void otPlatDnsUpstreamQueryDone(otInstance *aInstance, otPlatDnsUpstreamQuery *aTxn, otMessage *aResponse);
|
||||
|
||||
@@ -115,7 +115,7 @@ extern void otPlatMultipanSwitchoverDone(otInstance *aInstance, bool aSuccess);
|
||||
*
|
||||
* @param[in] aIid The IID of the interface.
|
||||
*
|
||||
* @retval Instance pointer if aIid is has an instance assigned, nullptr otherwise.
|
||||
* @retval Instance pointer if aIid is has an instance assigned, NULL otherwise.
|
||||
*/
|
||||
otInstance *otPlatMultipanIidToInstance(uint8_t aIid);
|
||||
|
||||
|
||||
@@ -1193,7 +1193,7 @@ otError otPlatRadioEnableCsl(otInstance *aInstance,
|
||||
/**
|
||||
* Reset CSL receiver in the platform.
|
||||
*
|
||||
* @note Defaults to `otPlatRadioEnableCsl(aInstance,0, Mac::kShortAddrInvalid, nullptr);`
|
||||
* @note Defaults to `otPlatRadioEnableCsl(aInstance,0, Mac::kShortAddrInvalid, NULL);`
|
||||
*
|
||||
* @param[in] aInstance The OpenThread instance structure.
|
||||
*
|
||||
@@ -1298,7 +1298,7 @@ otError otPlatRadioSetRegion(otInstance *aInstance, uint16_t aRegionCode);
|
||||
* @param[in] aInstance The OpenThread instance structure.
|
||||
* @param[out] aRegionCode The radio region.
|
||||
*
|
||||
* @retval OT_ERROR_INVALID_ARGS @p aRegionCode is nullptr.
|
||||
* @retval OT_ERROR_INVALID_ARGS @p aRegionCode is NULL.
|
||||
* @retval OT_ERROR_FAILED Other platform specific errors.
|
||||
* @retval OT_ERROR_NONE Successfully got region code.
|
||||
* @retval OT_ERROR_NOT_IMPLEMENTED The feature is not implemented.
|
||||
|
||||
Reference in New Issue
Block a user