From 4f5fa83194434acbecc3d39b1602f3977f1aaa6b Mon Sep 17 00:00:00 2001 From: Abtin Keshavarzian Date: Thu, 19 Oct 2017 12:52:47 -0700 Subject: [PATCH] [docs] fix typos in the comments (#2278) --- src/core/common/message.hpp | 2 +- src/core/mac/mac_filter.hpp | 3 ++- src/core/meshcop/dataset_manager.hpp | 14 +++++++------- src/core/thread/topology.hpp | 6 +++--- 4 files changed, 13 insertions(+), 12 deletions(-) diff --git a/src/core/common/message.hpp b/src/core/common/message.hpp index 5ee8295f2..772390b36 100644 --- a/src/core/common/message.hpp +++ b/src/core/common/message.hpp @@ -782,7 +782,7 @@ private: /** * This method sets the number of reserved header bytes. * - * @pram[in] aReservedHeader The number of header bytes to reserve. + * @param[in] aReservedHeader The number of header bytes to reserve. * */ void SetReserved(uint16_t aReservedHeader) { mBuffer.mHead.mInfo.mReserved = aReservedHeader; } diff --git a/src/core/mac/mac_filter.hpp b/src/core/mac/mac_filter.hpp index 53f9d0b6d..8589a04d3 100644 --- a/src/core/mac/mac_filter.hpp +++ b/src/core/mac/mac_filter.hpp @@ -199,7 +199,8 @@ public: * @param[out] aRss A reference to where the received signal strength to be placed. * * @retval OT_ERROR_NONE Successfully applied the filter rules on @p aExtAddress. - * @retval OT_ERROR_ADDRESS_FILTERED Address filter (whitelist or blacklist) is enabled and @p aExtAddress is filtered. + * @retval OT_ERROR_ADDRESS_FILTERED Address filter (whitelist or blacklist) is enabled and @p aExtAddress is + * filtered. * */ otError Apply(const ExtAddress &aExtAddress, int8_t &aRss); diff --git a/src/core/meshcop/dataset_manager.hpp b/src/core/meshcop/dataset_manager.hpp index ad4d6e841..aacd9f024 100644 --- a/src/core/meshcop/dataset_manager.hpp +++ b/src/core/meshcop/dataset_manager.hpp @@ -184,7 +184,7 @@ protected: * * @param[in] aHeader The CoAP header. * @param[in] aMessage The CoAP message buffer. - * @parma[in] aMessageInfo The message info. + * @param[in] aMessageInfo The message info. * */ void Get(const Coap::Header &aHeader, const Message &aMessage, const Ip6::MessageInfo &aMessageInfo) const; @@ -225,7 +225,7 @@ public: /** * This method sends a MGMT_SET request to the Leader. * - * @parma[in] aDataset The Operational Datset. + * @param[in] aDataset The Operational Datset. * @param[in] aTlvs Any additional raw TLVs to include. * @param[in] aLength Number of bytes in @p aTlvs. * @@ -239,7 +239,7 @@ public: * * @param[in] aTlvTypes The list of TLV types to request. * @param[in] aLength Number of bytes in @p aTlvTypes. - * @parma[in] aAddress The IPv6 destination address for the MGMT_GET request. + * @param[in] aAddress The IPv6 destination address for the MGMT_GET request. * * @retval OT_ERROR_NONE on success. * @@ -250,7 +250,7 @@ protected: /** * This method sets the Operational Dataset in non-volatile memory. * - * @parma[in] aDataset The Operational Dataset. + * @param[in] aDataset The Operational Dataset. * */ otError Set(const otOperationalDataset &aDataset); @@ -260,7 +260,7 @@ protected: * * @param[in] aHeader The CoAP header. * @param[in] aMessage The CoAP message buffer. - * @parma[in] aMessageInfo The message info. + * @param[in] aMessageInfo The message info. * * @retval OT_ERROR_NONE The MGMT_SET request message was handled successfully. * @retval OT_ERROR_DROP The MGMT_SET request message was dropped. @@ -314,7 +314,7 @@ public: /** * This method sets the Operational Dataset in non-volatile memory. * - * @parma[in] aDataset The Operational Dataset. + * @param[in] aDataset The Operational Dataset. * */ otError Set(const otOperationalDataset &aDataset); @@ -407,7 +407,7 @@ public: * * This method also starts the Delay Timer. * - * @parma[in] aDataset The Operational Dataset. + * @param[in] aDataset The Operational Dataset. * */ otError Set(const otOperationalDataset &aDataset); diff --git a/src/core/thread/topology.hpp b/src/core/thread/topology.hpp index 2ed4744ee..ce95c313a 100644 --- a/src/core/thread/topology.hpp +++ b/src/core/thread/topology.hpp @@ -190,7 +190,7 @@ public: /** * This method sets the key sequence value. * - * @parma[in] aKeySequence The key sequence value. + * @param[in] aKeySequence The key sequence value. * */ void SetKeySequence(uint32_t aKeySequence) { mKeySequence = aKeySequence; } @@ -318,9 +318,9 @@ public: const uint8_t *GetChallenge(void) const { return mValidPending.mPending.mChallenge; } /** - * This method returns the size (byets) of the challenge value for MLE Link Request/Response exchanges. + * This method returns the size (bytes) of the challenge value for MLE Link Request/Response exchanges. * - * @returns The size (byets) of the challenge value for MLE Link Request/Response exchanges. + * @returns The size (bytes) of the challenge value for MLE Link Request/Response exchanges. * */ uint8_t GetChallengeSize(void) const { return sizeof(mValidPending.mPending.mChallenge); }