Skip to content

Commit ffb8e4d

Browse files
authored
[docs] use NULL in place of nullptr (openthread#11435)
1 parent 424de28 commit ffb8e4d

7 files changed

Lines changed: 11 additions & 11 deletions

File tree

include/openthread/backbone_router_ftd.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ typedef enum
328328
*
329329
* @param[in] aContext The user context pointer.
330330
* @param[in] aEvent The ND Proxy event.
331-
* @param[in] aDua The Domain Unicast Address of the ND Proxy, or `nullptr` if @p aEvent is
331+
* @param[in] aDua The Domain Unicast Address of the ND Proxy, or NULL if @p aEvent is
332332
* `OT_BACKBONE_ROUTER_NDPROXY_CLEARED`.
333333
*/
334334
typedef void (*otBackboneRouterNdProxyCallback)(void *aContext,
@@ -385,7 +385,7 @@ typedef enum
385385
*
386386
* @param[in] aContext The user context pointer.
387387
* @param[in] aEvent The Domain Prefix event.
388-
* @param[in] aDomainPrefix The new Domain Prefix if added or changed, nullptr otherwise.
388+
* @param[in] aDomainPrefix The new Domain Prefix if added or changed, NULL otherwise.
389389
*/
390390
typedef void (*otBackboneRouterDomainPrefixCallback)(void *aContext,
391391
otBackboneRouterDomainPrefixEvent aEvent,

include/openthread/instance.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ extern "C" {
5252
*
5353
* @note This number versions both OpenThread platform and user APIs.
5454
*/
55-
#define OPENTHREAD_API_VERSION (499)
55+
#define OPENTHREAD_API_VERSION (500)
5656

5757
/**
5858
* @addtogroup api-instance

include/openthread/link.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1102,7 +1102,7 @@ otError otLinkSetRegion(otInstance *aInstance, uint16_t aRegionCode);
11021102
* @param[out] aRegionCode The radio region code. The `aRegionCode >> 8` is first ascii char
11031103
* and the `aRegionCode & 0xff` is the second ascii char.
11041104
*
1105-
* @retval OT_ERROR_INVALID_ARGS @p aRegionCode is nullptr.
1105+
* @retval OT_ERROR_INVALID_ARGS @p aRegionCode is NULL.
11061106
* @retval OT_ERROR_FAILED Other platform specific errors.
11071107
* @retval OT_ERROR_NONE Successfully got region code.
11081108
* @retval OT_ERROR_NOT_IMPLEMENTED The feature is not implemented.

include/openthread/nat64.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ void otIp4ToIp4MappedIp6Address(const otIp4Address *aIp4Address, otIp6Address *a
446446
* truncated but the outputted string is always null-terminated.
447447
*
448448
* @param[in] aAddress A pointer to an IPv4 address (MUST NOT be NULL).
449-
* @param[out] aBuffer A pointer to a char array to output the string (MUST NOT be `nullptr`).
449+
* @param[out] aBuffer A pointer to a char array to output the string (MUST NOT be NULL).
450450
* @param[in] aSize The size of @p aBuffer (in bytes).
451451
*/
452452
void otIp4AddressToString(const otIp4Address *aAddress, char *aBuffer, uint16_t aSize);
@@ -474,7 +474,7 @@ otError otIp4CidrFromString(const char *aString, otIp4Cidr *aCidr);
474474
* truncated but the outputted string is always null-terminated.
475475
*
476476
* @param[in] aCidr A pointer to an IPv4 CIDR (MUST NOT be NULL).
477-
* @param[out] aBuffer A pointer to a char array to output the string (MUST NOT be `nullptr`).
477+
* @param[out] aBuffer A pointer to a char array to output the string (MUST NOT be NULL).
478478
* @param[in] aSize The size of @p aBuffer (in bytes).
479479
*/
480480
void otIp4CidrToString(const otIp4Cidr *aCidr, char *aBuffer, uint16_t aSize);

include/openthread/platform/dns.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,11 @@ void otPlatDnsCancelUpstreamQuery(otInstance *aInstance, otPlatDnsUpstreamQuery
8787
* The transaction will be released, so the platform must not call on the same transaction twice. This function passes
8888
* the ownership of `aResponse` to OpenThread stack.
8989
*
90-
* Platform can pass a nullptr to close a transaction without a response.
90+
* Platform can pass NULL to close a transaction without a response.
9191
*
9292
* @param[in] aInstance The OpenThread instance structure.
9393
* @param[in] aTxn A pointer to the opaque DNS query transaction object.
94-
* @param[in] aResponse A message buffer of the DNS response payload or `nullptr` to close a transaction without a
94+
* @param[in] aResponse A message buffer of the DNS response payload or NULL to close a transaction without a
9595
* response.
9696
*/
9797
extern void otPlatDnsUpstreamQueryDone(otInstance *aInstance, otPlatDnsUpstreamQuery *aTxn, otMessage *aResponse);

include/openthread/platform/multipan.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ extern void otPlatMultipanSwitchoverDone(otInstance *aInstance, bool aSuccess);
115115
*
116116
* @param[in] aIid The IID of the interface.
117117
*
118-
* @retval Instance pointer if aIid is has an instance assigned, nullptr otherwise.
118+
* @retval Instance pointer if aIid is has an instance assigned, NULL otherwise.
119119
*/
120120
otInstance *otPlatMultipanIidToInstance(uint8_t aIid);
121121

include/openthread/platform/radio.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1193,7 +1193,7 @@ otError otPlatRadioEnableCsl(otInstance *aInstance,
11931193
/**
11941194
* Reset CSL receiver in the platform.
11951195
*
1196-
* @note Defaults to `otPlatRadioEnableCsl(aInstance,0, Mac::kShortAddrInvalid, nullptr);`
1196+
* @note Defaults to `otPlatRadioEnableCsl(aInstance,0, Mac::kShortAddrInvalid, NULL);`
11971197
*
11981198
* @param[in] aInstance The OpenThread instance structure.
11991199
*
@@ -1298,7 +1298,7 @@ otError otPlatRadioSetRegion(otInstance *aInstance, uint16_t aRegionCode);
12981298
* @param[in] aInstance The OpenThread instance structure.
12991299
* @param[out] aRegionCode The radio region.
13001300
*
1301-
* @retval OT_ERROR_INVALID_ARGS @p aRegionCode is nullptr.
1301+
* @retval OT_ERROR_INVALID_ARGS @p aRegionCode is NULL.
13021302
* @retval OT_ERROR_FAILED Other platform specific errors.
13031303
* @retval OT_ERROR_NONE Successfully got region code.
13041304
* @retval OT_ERROR_NOT_IMPLEMENTED The feature is not implemented.

0 commit comments

Comments
 (0)