From 94ac42eec910de8a2c8a02adc56b9c2043039770 Mon Sep 17 00:00:00 2001 From: Abtin Keshavarzian Date: Fri, 5 Oct 2018 00:56:55 -0700 Subject: [PATCH] [docs] fixing typos in comments/docs (#3120) --- examples/platforms/openthread-system.h | 2 +- examples/platforms/utils/flash.h | 2 +- include/openthread/platform/radio.h | 2 +- src/core/api/instance_api.cpp | 2 +- src/core/openthread-core-default-config.h | 2 +- src/ncp/spinel.h | 2 +- src/posix/platform/flash.h | 2 +- src/posix/platform/openthread-system.h | 2 +- src/posix/platform/radio_spinel.hpp | 6 +++--- 9 files changed, 11 insertions(+), 11 deletions(-) diff --git a/examples/platforms/openthread-system.h b/examples/platforms/openthread-system.h index 8ae241c6e..de8b2d13b 100644 --- a/examples/platforms/openthread-system.h +++ b/examples/platforms/openthread-system.h @@ -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. diff --git a/examples/platforms/utils/flash.h b/examples/platforms/utils/flash.h index 10c7029bb..659e787e6 100644 --- a/examples/platforms/utils/flash.h +++ b/examples/platforms/utils/flash.h @@ -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); diff --git a/include/openthread/platform/radio.h b/include/openthread/platform/radio.h index 6f9d337fd..5d9872383 100644 --- a/include/openthread/platform/radio.h +++ b/include/openthread/platform/radio.h @@ -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); diff --git a/src/core/api/instance_api.cpp b/src/core/api/instance_api.cpp index ab216cb7c..a85850bfe 100644 --- a/src/core/api/instance_api.cpp +++ b/src/core/api/instance_api.cpp @@ -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. * diff --git a/src/core/openthread-core-default-config.h b/src/core/openthread-core-default-config.h index 50163d38a..24bf34913 100644 --- a/src/core/openthread-core-default-config.h +++ b/src/core/openthread-core-default-config.h @@ -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 diff --git a/src/ncp/spinel.h b/src/ncp/spinel.h index 758aa74b5..47ebd5af3 100644 --- a/src/ncp/spinel.h +++ b/src/ncp/spinel.h @@ -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: * diff --git a/src/posix/platform/flash.h b/src/posix/platform/flash.h index 10c7029bb..659e787e6 100644 --- a/src/posix/platform/flash.h +++ b/src/posix/platform/flash.h @@ -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); diff --git a/src/posix/platform/openthread-system.h b/src/posix/platform/openthread-system.h index 8ae241c6e..de8b2d13b 100644 --- a/src/posix/platform/openthread-system.h +++ b/src/posix/platform/openthread-system.h @@ -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. diff --git a/src/posix/platform/radio_spinel.hpp b/src/posix/platform/radio_spinel.hpp index b26dbdf6a..16218da59 100644 --- a/src/posix/platform/radio_spinel.hpp +++ b/src/posix/platform/radio_spinel.hpp @@ -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.