From 9e4a24151ef58ecfbff934f57686aa34ec8f118a Mon Sep 17 00:00:00 2001 From: Jonathan Hui Date: Fri, 8 Oct 2021 15:39:31 -0700 Subject: [PATCH] [docs] fix typos in API docs (#7058) --- include/openthread/coap.h | 2 +- include/openthread/commissioner.h | 2 +- include/openthread/dnssd_server.h | 4 ++-- include/openthread/instance.h | 2 +- include/openthread/netdata_publisher.h | 4 ++-- include/openthread/platform/radio.h | 2 +- include/openthread/srp_client_buffers.h | 2 +- include/openthread/srp_server.h | 2 +- 8 files changed, 10 insertions(+), 10 deletions(-) diff --git a/include/openthread/coap.h b/include/openthread/coap.h index 2a2df22ae..7e2312040 100644 --- a/include/openthread/coap.h +++ b/include/openthread/coap.h @@ -367,7 +367,7 @@ typedef void (*otCoapRequestHandler)(void *aContext, otMessage *aMessage, const * @param[in] aPosition The position of @p aBlock in a sequence in bytes. * @param[in] aBlockLength The length of the block segment in bytes. * @param[in] aMore Flag if more block segments are following. - * @param[in] aTotalLength The total length in bytes of the transfered information (indicated by a Size1 or Size2 + * @param[in] aTotalLength The total length in bytes of the transferred information (indicated by a Size1 or Size2 * option). * * @retval OT_ERROR_NONE Block segment was stored successfully. diff --git a/include/openthread/commissioner.h b/include/openthread/commissioner.h index 42d3cced0..f142edcb0 100644 --- a/include/openthread/commissioner.h +++ b/include/openthread/commissioner.h @@ -125,7 +125,7 @@ typedef struct otJoinerPskd } otJoinerPskd; /** - * This enumeration defines a Joiner Info Typer. + * This enumeration defines a Joiner Info Type. * */ typedef enum otJoinerInfoType diff --git a/include/openthread/dnssd_server.h b/include/openthread/dnssd_server.h index 9b0c940cb..abcac362e 100644 --- a/include/openthread/dnssd_server.h +++ b/include/openthread/dnssd_server.h @@ -198,7 +198,7 @@ void otDnssdQueryHandleDiscoveredServiceInstance(otInstance * aIn void otDnssdQueryHandleDiscoveredHost(otInstance *aInstance, const char *aHostFullName, otDnssdHostInfo *aHostInfo); /** - * This function aquires the next query in the DNS-SD server. + * This function acquires the next query in the DNS-SD server. * * @param[in] aInstance The OpenThread instance structure. * @param[in] aQuery The query pointer. Pass NULL to get the first query. @@ -209,7 +209,7 @@ void otDnssdQueryHandleDiscoveredHost(otInstance *aInstance, const char *aHostFu const otDnssdQuery *otDnssdGetNextQuery(otInstance *aInstance, const otDnssdQuery *aQuery); /** - * This function aquires the DNS-SD query type and name for a specific query. + * This function acquires the DNS-SD query type and name for a specific query. * * @param[in] aQuery The query pointer acquired from `otDnssdGetNextQuery`. * @param[out] aNameOutput The name output buffer, which should be `OT_DNS_MAX_NAME_SIZE` bytes long. diff --git a/include/openthread/instance.h b/include/openthread/instance.h index 09ef0efbf..4837626e0 100644 --- a/include/openthread/instance.h +++ b/include/openthread/instance.h @@ -53,7 +53,7 @@ extern "C" { * @note This number versions both OpenThread platform and user APIs. * */ -#define OPENTHREAD_API_VERSION (170) +#define OPENTHREAD_API_VERSION (171) /** * @addtogroup api-instance diff --git a/include/openthread/netdata_publisher.h b/include/openthread/netdata_publisher.h index d3abc3b0c..fa44686be 100644 --- a/include/openthread/netdata_publisher.h +++ b/include/openthread/netdata_publisher.h @@ -152,7 +152,7 @@ void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(otInstance *aInstance, uin * @param[in] aInstance A pointer to an OpenThread instance. * * @retval TRUE The published DNS/SRP Service entry is added to the Thread Network Data. - * @retval FLASE The entry is not added to Thread Network Data or there is no entry to publish. + * @retval FALSE The entry is not added to Thread Network Data or there is no entry to publish. * */ bool otNetDataIsDnsSrpServiceAdded(otInstance *aInstance); @@ -235,7 +235,7 @@ otError otNetDataPublishExternalRoute(otInstance *aInstance, const otExternalRou * @param[in] aPrefix A pointer to the prefix (MUST NOT be NULL). * * @retval TRUE The published prefix entry is added to the Thread Network Data. - * @retval FLASE The entry is not added to Thread Network Data or there is no entry to publish. + * @retval FALSE The entry is not added to Thread Network Data or there is no entry to publish. * */ bool otNetDataIsPrefixAdded(otInstance *aInstance, const otIp6Prefix *aPrefix); diff --git a/include/openthread/platform/radio.h b/include/openthread/platform/radio.h index 969e7bd46..02e58aeb8 100644 --- a/include/openthread/platform/radio.h +++ b/include/openthread/platform/radio.h @@ -1076,7 +1076,7 @@ uint8_t otPlatRadioGetCslClockUncertainty(otInstance *aInstance); * @retval OT_ERROR_NOT_IMPLEMENTED The feature is not implemented * @retval OT_ERROR_INVALID_ARGS The specified channel is not valid. * @retval OT_ERROR_FAILED Other platform specific errors. - * @retval OT_ERROR_NONE Successfully set max transmit poewr. + * @retval OT_ERROR_NONE Successfully set max transmit power. * */ otError otPlatRadioSetChannelMaxTransmitPower(otInstance *aInstance, uint8_t aChannel, int8_t aMaxPower); diff --git a/include/openthread/srp_client_buffers.h b/include/openthread/srp_client_buffers.h index 07c88b793..1f8c457c8 100644 --- a/include/openthread/srp_client_buffers.h +++ b/include/openthread/srp_client_buffers.h @@ -121,7 +121,7 @@ otSrpClientBuffersServiceEntry *otSrpClientBuffersAllocateService(otInstance *aI * the behavior of this function is undefined. * * @param[in] aInstance A pointer to the OpenThread instance. - * @param[in] aSevice A pointer to the service entry to free (MUST NOT be NULL). + * @param[in] aService A pointer to the service entry to free (MUST NOT be NULL). * */ void otSrpClientBuffersFreeService(otInstance *aInstance, otSrpClientBuffersServiceEntry *aService); diff --git a/include/openthread/srp_server.h b/include/openthread/srp_server.h index e0fb4b06d..1eceb2b4d 100644 --- a/include/openthread/srp_server.h +++ b/include/openthread/srp_server.h @@ -428,7 +428,7 @@ const otSrpServerService *otSrpServerHostGetNextService(const otSrpServerHost * * * To iterate over sub-types of a specific instance name `instanceName`: * service = otSrpServerHostFindNextService(host, service, OT_SRP_SERVER_FLAGS_SUB_TYPE_SERVICE_ONLY, NULL, - * insatnceName); + * instanceName); * * To find a specific service with service name `serviceName` and service instance name `instanceName`: * service = otSrpServerHostFindNextService(host, NULL, OT_SRP_SERVER_FLAGS_ANY_SERVICE, serviceName, instanceName);