From f40eeeb1459551707ff3adc314e82842956cab03 Mon Sep 17 00:00:00 2001 From: jrhodie <139580534+jrhodie@users.noreply.github.com> Date: Mon, 8 Jan 2024 13:55:25 -0800 Subject: [PATCH] [docs] fixed some common typos (#9752) --- include/openthread/coap.h | 2 +- include/openthread/dns_client.h | 2 +- include/openthread/instance.h | 2 +- include/openthread/tcp.h | 2 +- include/openthread/thread.h | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/include/openthread/coap.h b/include/openthread/coap.h index 4b7149adb..d5d02060b 100644 --- a/include/openthread/coap.h +++ b/include/openthread/coap.h @@ -357,7 +357,7 @@ typedef void (*otCoapResponseHandler)(void *aContext, typedef void (*otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo); /** - * Pointer is called when a CoAP message with an block-wise transfer option is received. + * Pointer is called when a CoAP message with a block-wise transfer option is received. * * Is available when OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE configuration * is enabled. diff --git a/include/openthread/dns_client.h b/include/openthread/dns_client.h index 0fd345804..49dcdfdb3 100644 --- a/include/openthread/dns_client.h +++ b/include/openthread/dns_client.h @@ -408,7 +408,7 @@ otError otDnsBrowseResponseGetServiceName(const otDnsBrowseResponse *aResponse, * MUST only be used from `otDnsBrowseCallback`. * * The response may include multiple service instance records. @p aIndex can be used to iterate through the list. Index - * zero gives the the first record. When we reach end of the list, `OT_ERROR_NOT_FOUND` is returned. + * zero gives the first record. When we reach end of the list, `OT_ERROR_NOT_FOUND` is returned. * * Note that this function gets the service instance label and not the full service instance name which is of the form * `..`. diff --git a/include/openthread/instance.h b/include/openthread/instance.h index 05c7ce4f0..1a97f96e5 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 (388) +#define OPENTHREAD_API_VERSION (389) /** * @addtogroup api-instance diff --git a/include/openthread/tcp.h b/include/openthread/tcp.h index caa0d4efd..649a4b472 100644 --- a/include/openthread/tcp.h +++ b/include/openthread/tcp.h @@ -231,7 +231,7 @@ typedef void (*otTcpDisconnected)(otTcpEndpoint *aEndpoint, otTcpDisconnectedRea /** * Represents a TCP endpoint. * - * An TCP endpoint acts an endpoint of TCP connection. It can be used to + * A TCP endpoint acts an endpoint of TCP connection. It can be used to * initiate TCP connections, and, once a TCP connection is established, send * data to and receive data from the connection peer. * diff --git a/include/openthread/thread.h b/include/openthread/thread.h index cb0d6bda2..b077001e4 100644 --- a/include/openthread/thread.h +++ b/include/openthread/thread.h @@ -238,7 +238,7 @@ typedef void (*otDetachGracefullyCallback)(void *aContext); * @param[in] aEnabled TRUE if Thread is enabled, FALSE otherwise. * * @retval OT_ERROR_NONE Successfully started Thread protocol operation. - * @retval OT_ERROR_INVALID_STATE The network interface was not not up. + * @retval OT_ERROR_INVALID_STATE The network interface was not up. * */ otError otThreadSetEnabled(otInstance *aInstance, bool aEnabled);