[docs] fixing typos in comments/docs (#3120)

This commit is contained in:
Abtin Keshavarzian
2018-10-05 00:56:55 -07:00
committed by Jonathan Hui
parent abe64591c7
commit 94ac42eec9
9 changed files with 11 additions and 11 deletions
+1 -1
View File
@@ -45,7 +45,7 @@ extern "C" {
* This function performs all platform-specific initialization of OpenThread's drivers.
*
* @note This function is not called by the OpenThread library. Instead, the system/RTOS should call this function
* when initialization of OpenThread's drivers is most approriate.
* when initialization of OpenThread's drivers is most appropriate.
*
* @param[in] argc Number of arguments in @p argv.
* @param[in] argv Argument vector.
+1 -1
View File
@@ -71,7 +71,7 @@ uint32_t utilsFlashGetSize(void);
*
* @retval OT_ERROR_NONE Erase flash operation is started.
* @retval OT_ERROR_FAILED Erase flash operation is not started.
* @retval OT_ERROR_INVALID_ARGS aAddress is out of range of flash or not aligend.
* @retval OT_ERROR_INVALID_ARGS aAddress is out of range of flash or not aligned.
*/
otError utilsFlashErasePage(uint32_t aAddress);
+1 -1
View File
@@ -629,7 +629,7 @@ int8_t otPlatRadioGetReceiveSensitivity(otInstance *aInstance);
* via @p aFrame, but should not read/write any state within OpenThread.
*
* @param[in] aInstance The OpenThread instance structure.
* @param[in] aFrame The radio frame which neeeds to process transmit security.
* @param[in] aFrame The radio frame which needs to process transmit security.
*
*/
extern void otPlatRadioFrameUpdated(otInstance *aInstance, otRadioFrame *aFrame);
+1 -1
View File
@@ -156,7 +156,7 @@ const char *otGetVersionString(void)
* intended to be used to specify compiler directives to indicate
* what linker section the platform version string should be stored.
*
* This is useful for specifying an exact locaiton of where the version
* This is useful for specifying an exact location of where the version
* string will be located so that it can be easily retrieved from the
* raw firmware image.
*
+1 -1
View File
@@ -1758,7 +1758,7 @@
* to support following features:
* 1. Time synchronization service feature (i.e., OPENTHREAD_CONFIG_ENABLE_TIME_SYNC is set).
*
* @note If it's enabled, plaforms must support interrupt context and concurrent access AES.
* @note If it's enabled, platform must support interrupt context and concurrent access AES.
*
*/
#ifndef OPENTHREAD_CONFIG_HEADER_IE_SUPPORT
+1 -1
View File
@@ -1612,7 +1612,7 @@ typedef enum {
* `D`: Log metadata (optional).
*
* Any data after the log string is considered metadata and is OPTIONAL.
* Pretense of `SPINEL_CAP_OPENTHREAD_LOG_METADATA` capability
* Presence of `SPINEL_CAP_OPENTHREAD_LOG_METADATA` capability
* indicates that OpenThread log metadata format is used as defined
* below:
*
+1 -1
View File
@@ -71,7 +71,7 @@ uint32_t utilsFlashGetSize(void);
*
* @retval OT_ERROR_NONE Erase flash operation is started.
* @retval OT_ERROR_FAILED Erase flash operation is not started.
* @retval OT_ERROR_INVALID_ARGS aAddress is out of range of flash or not aligend.
* @retval OT_ERROR_INVALID_ARGS aAddress is out of range of flash or not aligned.
*/
otError utilsFlashErasePage(uint32_t aAddress);
+1 -1
View File
@@ -45,7 +45,7 @@ extern "C" {
* This function performs all platform-specific initialization of OpenThread's drivers.
*
* @note This function is not called by the OpenThread library. Instead, the system/RTOS should call this function
* when initialization of OpenThread's drivers is most approriate.
* when initialization of OpenThread's drivers is most appropriate.
*
* @param[in] argc Number of arguments in @p argv.
* @param[in] argv Argument vector.
+3 -3
View File
@@ -312,7 +312,7 @@ public:
otError Transmit(otRadioFrame &aFrame);
/**
* This method swithes the radio state from Sleep to Receive.
* This method switches the radio state from Sleep to Receive.
*
* @param[in] aChannel The channel to use for receiving.
*
@@ -434,7 +434,7 @@ public:
private:
enum
{
kMaxSpinelFrame = 2048, ///< Max size in bytes for transfering spinel frames.
kMaxSpinelFrame = 2048, ///< Max size in bytes for transferring spinel frames.
kMaxWaitTime = 2000, ///< Max time to wait for response in milliseconds.
};
@@ -555,7 +555,7 @@ private:
spinel_tid_t mWaitingTid; ///< The transaction id of current transaction.
spinel_prop_key_t mWaitingKey; ///< The property key of current transaction.
const char * mPropertyFormat; ///< The spinel property format of current transaction.
va_list mPropertyArgs; ///< The arguments pack or unpack spinel property of current transcation.
va_list mPropertyArgs; ///< The arguments pack or unpack spinel property of current transaction.
uint32_t mExpectedCommand; ///< Expected response command of current transaction.
otError mError; ///< The result of current transaction.