[api] fix typos (#3431)

This commit is contained in:
Jonathan Hui
2019-01-07 09:03:55 -08:00
committed by GitHub
parent a42efee470
commit dfd2b9b032
9 changed files with 10 additions and 10 deletions
+1 -1
View File
@@ -128,7 +128,7 @@ otError otChannelManagerSetDelay(otInstance *aInstance, uint16_t aDelay);
* @retval OT_ERROR_NONE Channel selection finished successfully.
* @retval OT_ERROR_NOT_FOUND Supported channel mask is empty, therefore could not select a channel.
* @retval OT_ERROR_INVALID_STATE Thread is not enabled or not enough data to select a new channel.
* @retval OT_ERROR_DISABLED_FEATURE `ChannelMonintor` feature is disabled by build-time configuration options.
* @retval OT_ERROR_DISABLED_FEATURE `ChannelMonitor` feature is disabled by build-time configuration options.
*
*/
otError otChannelManagerRequestChannelSelect(otInstance *aInstance, bool aSkipQualityCheck);
+1 -1
View File
@@ -329,7 +329,7 @@ typedef struct otCoapHeader
* @param[in] aResult A result of the CoAP transaction.
*
* @retval OT_ERROR_NONE A response was received successfully.
* @retval OT_ERROR_ABORT A CoAP transaction was reseted by peer.
* @retval OT_ERROR_ABORT A CoAP transaction was reset by peer.
* @retval OT_ERROR_RESPONSE_TIMEOUT No response or acknowledgment received during timeout period.
*
*/
+1 -1
View File
@@ -231,7 +231,7 @@ bool otCoapSecureIsConnected(otInstance *aInstance);
* @retval FALSE If DTLS session is not active.
*
*/
bool otCoapSecureIsConncetionActive(otInstance *aInstance);
bool otCoapSecureIsConnectionActive(otInstance *aInstance);
/**
* This method sends a CoAP request over secure DTLS connection.
+1 -1
View File
@@ -118,7 +118,7 @@ void otCryptoAesCcm(const uint8_t *aKey,
* @retval OT_ERROR_NONE ECDSA sign has been created successfully.
* @retval OT_ERROR_NO_BUFS Output buffer is too small.
* @retval OT_ERROR_INVALID_ARGS Private key is not valid EC Private Key.
* @rerval OT_ERROR_FAILED Error during signing.
* @retval OT_ERROR_FAILED Error during signing.
*/
otError otCryptoEcdsaSign(uint8_t * aOutput,
uint16_t * aOutputLength,
+2 -2
View File
@@ -245,10 +245,10 @@ otError otLinkRawEnergyScan(otInstance * aInstance,
otLinkRawEnergyScanDone aCallback);
/**
* Enable/Disable source match for AutoPend.
* Enable/Disable source match for frame pending.
*
* @param[in] aInstance A pointer to an OpenThread instance.
* @param[in] aEnable Enable/disable source match for automatical pending.
* @param[in] aEnable Enable/disable source match for frame pending.
*
* @retval OT_ERROR_NONE If successful.
* @retval OT_ERROR_INVALID_STATE If the raw link-layer isn't enabled.
+1 -1
View File
@@ -166,7 +166,7 @@ typedef struct otMleCounters
uint16_t mRouterRole; ///< Number of times device entered OT_DEVICE_ROLE_ROUTER role.
uint16_t mLeaderRole; ///< Number of times device entered OT_DEVICE_ROLE_LEADER role.
uint16_t mAttachAttempts; ///< Number of attach attempts while device was detached.
uint16_t mParitionIdChanges; ///< Number of changes to partition ID.
uint16_t mPartitionIdChanges; ///< Number of changes to partition ID.
uint16_t mBetterPartitionAttachAttempts; ///< Number of attempts to attach to a better partition.
/**