[docs] fix typos in API docs (#7058)

This commit is contained in:
Jonathan Hui
2021-10-08 15:39:31 -07:00
committed by GitHub
parent 27dc37ea8d
commit 9e4a24151e
8 changed files with 10 additions and 10 deletions
+1 -1
View File
@@ -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.
+1 -1
View File
@@ -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
+2 -2
View File
@@ -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.
+1 -1
View File
@@ -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
+2 -2
View File
@@ -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);
+1 -1
View File
@@ -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);
+1 -1
View File
@@ -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);
+1 -1
View File
@@ -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);