diff --git a/include/openthread/cli.h b/include/openthread/cli.h index 5878ac4de..3fa5c5653 100644 --- a/include/openthread/cli.h +++ b/include/openthread/cli.h @@ -70,9 +70,9 @@ typedef struct otCliCommand /** * This function pointer is called to notify about Console output. * - * @param[in] aBuf A pointer to a buffer with an output. - * @param[in] aBufLength A length of the output data stored in the buffer. * @param[out] aContext A user context pointer. + * @param[in] aFormat The format string. + * @param[in] aArguments The format string arguments. * * @returns Number of bytes written by the callback. * diff --git a/include/openthread/commissioner.h b/include/openthread/commissioner.h index fc762f280..5e4f3ddde 100644 --- a/include/openthread/commissioner.h +++ b/include/openthread/commissioner.h @@ -154,10 +154,8 @@ typedef struct otJoinerInfo /** * This function pointer is called whenever the commissioner state changes. * - * @param[in] aChannelMask The channel mask value. - * @param[in] aEnergyList A pointer to the energy measurement list. - * @param[in] aEnergyListLength Number of entries in @p aEnergyListLength. - * @param[in] aContext A pointer to application-specific context. + * @param[in] aState The Commissioner state. + * @param[in] aContext A pointer to application-specific context. * */ typedef void (*otCommissionerStateCallback)(otCommissionerState aState, void *aContext); @@ -280,7 +278,7 @@ otError otCommissionerRemoveJoiner(otInstance *aInstance, const otExtAddress *aE * This function removes a Joiner entry. * * @param[in] aInstance A pointer to an OpenThread instance. - * @param[in] aEui64 A pointer to the Joiner Discerner. + * @param[in] aDiscerner A pointer to the Joiner Discerner. * * @retval OT_ERROR_NONE Successfully removed the Joiner. * @retval OT_ERROR_NOT_FOUND The Joiner specified by @p aEui64 was not found. diff --git a/include/openthread/instance.h b/include/openthread/instance.h index 7795fb686..7b3379330 100644 --- a/include/openthread/instance.h +++ b/include/openthread/instance.h @@ -53,7 +53,7 @@ extern "C" { * @note This number versions both OpenThread platform and user APIs. * */ -#define OPENTHREAD_API_VERSION (197) +#define OPENTHREAD_API_VERSION (198) /** * @addtogroup api-instance diff --git a/include/openthread/ip6.h b/include/openthread/ip6.h index a055acf87..00f20b098 100644 --- a/include/openthread/ip6.h +++ b/include/openthread/ip6.h @@ -734,7 +734,7 @@ void otIp6SetSlaacEnabled(otInstance *aInstance, bool aEnabled); * when it is about to add a SLAAC address based on a prefix. Its boolean return value determines whether the address * is filtered (not added) or not. * - * @param[in] aInstacne A pointer to an OpenThread instance. + * @param[in] aInstance A pointer to an OpenThread instance. * @param[in] aPrefix A pointer to prefix for which SLAAC address is about to be added. * * @retval TRUE Indicates that the SLAAC address based on the prefix should be filtered and NOT added. diff --git a/include/openthread/platform/crypto.h b/include/openthread/platform/crypto.h index a05eb1ab4..7cadc8e79 100644 --- a/include/openthread/platform/crypto.h +++ b/include/openthread/platform/crypto.h @@ -374,7 +374,7 @@ otError otPlatCryptoHkdfExpand(otCryptoContext *aContext, * * @param[in] aContext Operation context for HKDF operation. * @param[in] aSalt Pointer to the Salt for HKDF. - * @param[in] aInfoLength length of Salt. + * @param[in] aSaltLength Length of Salt. * @param[in] aInputKey Pointer to the input key. * * @retval OT_ERROR_NONE HKDF Extract was successful. @@ -455,7 +455,6 @@ otError otPlatCryptoSha256Update(otCryptoContext *aContext, const void *aBuf, ui * Finish SHA-256 operation. * * @param[in] aContext Context for SHA-256 operation. - * @param[in] aContextSize Context size SHA-256 operation. * @param[in] aHash A pointer to the output buffer, where hash needs to be stored. * @param[in] aHashSize The length of @p aHash in bytes. * diff --git a/include/openthread/platform/radio.h b/include/openthread/platform/radio.h index 2d7a654b9..6e85030c0 100644 --- a/include/openthread/platform/radio.h +++ b/include/openthread/platform/radio.h @@ -1126,8 +1126,8 @@ otError otPlatRadioGetRegion(otInstance *aInstance, uint16_t *aRegionCode); * @param[in] aInstance The OpenThread instance structure. * @param[in] aLinkMetrics This parameter specifies what metrics to query. Per spec 4.11.3.4.4.6, at most 2 metrics * can be specified. The probing would be disabled if @p `aLinkMetrics` is bitwise 0. - * @param[in] aShortAddr The short address of the Probing Initiator. - * @param[in] aExtAddr The extended source address of the Probing Initiator. @p aExtAddr MUST NOT be `NULL`. + * @param[in] aShortAddress The short address of the Probing Initiator. + * @param[in] aExtAddress The extended source address of the Probing Initiator. @p aExtAddr MUST NOT be `NULL`. * * @retval OT_ERROR_NONE Successfully configured the Enhanced-ACK Based Probing. * @retval OT_ERROR_INVALID_ARGS @p aExtAddress is `NULL`. diff --git a/include/openthread/srp_client.h b/include/openthread/srp_client.h index ba7801e34..72c03610a 100644 --- a/include/openthread/srp_client.h +++ b/include/openthread/srp_client.h @@ -160,7 +160,7 @@ typedef struct otSrpClientService * * @param[in] aError The error (see above). * @param[in] aHostInfo A pointer to host info. - * @param[in] aService The head of linked-list containing all services (excluding the ones removed). NULL if + * @param[in] aServices The head of linked-list containing all services (excluding the ones removed). NULL if * the list is empty. * @param[in] aRemovedServices The head of linked-list containing all removed services. NULL if the list is empty. * @param[in] aContext A pointer to an arbitrary context (provided when callback was registered). @@ -180,9 +180,9 @@ typedef void (*otSrpClientCallback)(otError aError, * This callback is invoked when auto-start mode is enabled and the SRP client is either automatically started or * stopped. * - * @param[in] aServerSockAddress A non-NULL pointer indicates SRP server was started and pointer will give the - * selected server socket address. A NULL pointer indicates SRP server was stopped. - * @param[in] aContext A pointer to an arbitrary context (provided when callback was registered). + * @param[in] aServerSockAddr A non-NULL pointer indicates SRP server was started and pointer will give the + * selected server socket address. A NULL pointer indicates SRP server was stopped. + * @param[in] aContext A pointer to an arbitrary context (provided when callback was registered). * */ typedef void (*otSrpClientAutoStartCallback)(const otSockAddr *aServerSockAddr, void *aContext); @@ -408,15 +408,15 @@ otError otSrpClientSetHostName(otInstance *aInstance, const char *aName); * request from an earlier call to `otSrpClientRemoveHostAndServices()` and host info still being in either * `STATE_TO_REMOVE` or `STATE_REMOVING` states). * - * The host IPv6 address array pointed to by @p aAddresses MUST persist and remain unchanged after returning from this - * function (with `OT_ERROR_NONE`). OpenThread will save the pointer to the array. + * The host IPv6 address array pointed to by @p aIp6Addresses MUST persist and remain unchanged after returning from + * this function (with `OT_ERROR_NONE`). OpenThread will save the pointer to the array. * * After a successful call to this function, `otSrpClientCallback` will be called to report the status of the address * registration with SRP server. * * @param[in] aInstance A pointer to the OpenThread instance. - * @param[in] aAddresses A pointer to the an array containing the host IPv6 addresses. - * @param[in] aNumAddresses The number of addresses in the @p aAddresses array. + * @param[in] aIp6Addresses A pointer to the an array containing the host IPv6 addresses. + * @param[in] aNumAddresses The number of addresses in the @p aIp6Addresses array. * * @retval OT_ERROR_NONE The host IPv6 address list change started successfully. The `otSrpClientCallback` * will be called to report the status of registering addresses with server. diff --git a/include/openthread/thread.h b/include/openthread/thread.h index 183b4fff8..fe829003c 100644 --- a/include/openthread/thread.h +++ b/include/openthread/thread.h @@ -872,7 +872,7 @@ void otThreadResetMleCounters(otInstance *aInstance); /** * This function pointer is called every time an MLE Parent Response message is received. * - * @param[in] aStats pointer to a location on stack holding the stats data. + * @param[in] aInfo A pointer to a location on stack holding the stats data. * @param[in] aContext A pointer to callback client-specific context. * */ diff --git a/include/openthread/thread_ftd.h b/include/openthread/thread_ftd.h index 31421890f..ea052deed 100644 --- a/include/openthread/thread_ftd.h +++ b/include/openthread/thread_ftd.h @@ -605,7 +605,7 @@ otError otThreadSetPskc(otInstance *aInstance, const otPskc *aPskc); * non-volatile memory. * * @param[in] aInstance A pointer to an OpenThread instance. - * @param[in] aPskcRef Key Reference to the new Thread PSKc. + * @param[in] aKeyRef Key Reference to the new Thread PSKc. * * @retval OT_ERROR_NONE Successfully set the Thread PSKc. * @retval OT_ERROR_INVALID_STATE Thread protocols are enabled. diff --git a/src/cli/cli.hpp b/src/cli/cli.hpp index ee46c994d..bc15dfa89 100644 --- a/src/cli/cli.hpp +++ b/src/cli/cli.hpp @@ -165,7 +165,7 @@ public: /** * This static method checks a given argument string against "enable" or "disable" commands. * - * @param[in] aArgs The argument string to parse. + * @param[in] aArg The argument string to parse. * @param[out] aEnable Boolean variable to return outcome on success. * Set to TRUE for "enable" command, and FALSE for "disable" command. * @@ -178,9 +178,9 @@ public: /** * This method sets the user command table. * - * @param[in] aUserCommands A pointer to an array with user commands. - * @param[in] aLength @p aUserCommands length. - * @param[in] aContext @p aUserCommands length. + * @param[in] aCommands A pointer to an array with user commands. + * @param[in] aLength @p aUserCommands length. + * @param[in] aContext @p aUserCommands length. * */ void SetUserCommands(const otCliCommand *aCommands, uint8_t aLength, void *aContext); diff --git a/src/cli/cli_output.hpp b/src/cli/cli_output.hpp index 94b75a6e9..61e8997a7 100644 --- a/src/cli/cli_output.hpp +++ b/src/cli/cli_output.hpp @@ -379,7 +379,7 @@ public: * @tparam kTableNumColumns The number columns in the table. * * @param[in] aTitles An array specifying the table column titles. - * @param[in] aWidth An array specifying the table column widths (in number of chars). + * @param[in] aWidths An array specifying the table column widths (in number of chars). * */ template @@ -399,7 +399,7 @@ public: * * @tparam kTableNumColumns The number columns in the table. * - * @param[in] aWidth An array specifying the table column widths (in number of chars). + * @param[in] aWidths An array specifying the table column widths (in number of chars). * */ template void OutputTableSeparator(const uint8_t (&aWidths)[kTableNumColumns]) diff --git a/src/cli/cli_udp.hpp b/src/cli/cli_udp.hpp index 11dfc57dc..bd8ba5462 100644 --- a/src/cli/cli_udp.hpp +++ b/src/cli/cli_udp.hpp @@ -55,7 +55,7 @@ public: /** * Constructor * - * @param[in] aOutputContext The CLI console output context. + * @param[in] aOutput The CLI console output context. * */ explicit UdpExample(Output &aOutput); diff --git a/src/core/coap/coap_secure.hpp b/src/core/coap/coap_secure.hpp index cd01ada6b..be8caf67b 100644 --- a/src/core/coap/coap_secure.hpp +++ b/src/core/coap/coap_secure.hpp @@ -209,8 +209,8 @@ public: * * DTLS mode "ECDHE ECDSA with AES 128 CCM 8" for Application CoAPS. * - * @param[in] aX509Certificate A pointer to the PEM formatted X509 PEM certificate. - * @param[in] aX509CertLength The length of certificate. + * @param[in] aX509Cert A pointer to the PEM formatted X509 PEM certificate. + * @param[in] aX509Length The length of certificate. * @param[in] aPrivateKey A pointer to the PEM formatted private key. * @param[in] aPrivateKeyLength The length of the private key. * diff --git a/src/core/common/array.hpp b/src/core/common/array.hpp index 068bfbfea..ded006f93 100644 --- a/src/core/common/array.hpp +++ b/src/core/common/array.hpp @@ -50,10 +50,8 @@ namespace ot { * This template function is `constexpr`. The template arguments are expected to be deduced by the compiler allowing * callers to simply use `GetArrayLength(aArray)`. * - * @tparam Type The array element type. - * @tparam kLength The array length. - * - * @param[in] aArray A reference to the array. + * @tparam Type The array element type. + * @tparam kArrayLength The array length. * * @returns The array length (number of elements in the array). * @@ -69,8 +67,8 @@ template constexpr inline uint16_t GetArr * Note that the past-the-end element is a theoretical element that would follow the last element in the array. It does * not point to an actual element in array, and thus should not be dereferenced. * - * @tparam Type The array element type. - * @tparam kLength The array length. + * @tparam Type The array element type. + * @tparam kArrayLength The array length. * * @param[in] aArray A reference to the array. * @@ -88,8 +86,8 @@ template inline Type *GetArrayEnd(Type (& * Note that the past-the-end element is a theoretical element that would follow the last element in the array. It does * not point to an actual element in array, and thus should not be dereferenced. * - * @tparam Type The array element type. - * @tparam kLength The array length. + * @tparam Type The array element type. + * @tparam kArrayLength The array length. * * @param[in] aArray A reference to the array. * diff --git a/src/core/common/heap_array.hpp b/src/core/common/heap_array.hpp index e65e23a34..a4ede9027 100644 --- a/src/core/common/heap_array.hpp +++ b/src/core/common/heap_array.hpp @@ -354,8 +354,6 @@ public: * * This method will invoke the `Type` destructor on the removed element. * - * @returns A pointer to the removed element from the array, or `nullptr` if array is empty. - * */ void PopBack(void) { diff --git a/src/core/common/message.hpp b/src/core/common/message.hpp index 7999d2bd0..3d7da03ed 100644 --- a/src/core/common/message.hpp +++ b/src/core/common/message.hpp @@ -1077,7 +1077,7 @@ public: * The given LQI value would be added to the average. Note that a message can be composed of multiple 802.15.4 * frame fragments each received with a different signal strength. * - * @param[in] aLQI A new LQI value (has no unit) to be added to average. + * @param[in] aLqi A new LQI value (has no unit) to be added to average. * */ void AddLqi(uint8_t aLqi) { GetMetadata().mLqiAverager.Add(aLqi); } diff --git a/src/core/common/notifier.hpp b/src/core/common/notifier.hpp index e0b7f1dd0..8887671af 100644 --- a/src/core/common/notifier.hpp +++ b/src/core/common/notifier.hpp @@ -222,7 +222,7 @@ public: * This method removes/unregisters a previously registered `otStateChangedCallback` handler. * * @param[in] aCallback A pointer to the callback function pointer. - * @param[in] aContex A pointer to arbitrary context information. + * @param[in] aContext A pointer to arbitrary context information. * */ void RemoveCallback(otStateChangedCallback aCallback, void *aContext); diff --git a/src/core/common/settings.hpp b/src/core/common/settings.hpp index 335fd3780..5197dd501 100644 --- a/src/core/common/settings.hpp +++ b/src/core/common/settings.hpp @@ -478,7 +478,7 @@ public: /** * This method sets the Thread device mode. * - * @param[in] aRloc16 The Thread device mode. + * @param[in] aMode The Thread device mode. * */ void SetMode(uint8_t aMode) { mMode = aMode; } @@ -920,7 +920,7 @@ public: * * @tparam EntryType The settings entry type. * - * @param[in] aEntry The entry value to be saved. + * @param[in] aValue The entry value to be saved. * * @retval kErrorNone Successfully saved Network Info in settings. * @retval kErrorNotImplemented The platform does not implement settings functionality. diff --git a/src/core/common/tlvs.hpp b/src/core/common/tlvs.hpp index d624ff9cb..4dd55f4d6 100644 --- a/src/core/common/tlvs.hpp +++ b/src/core/common/tlvs.hpp @@ -331,7 +331,6 @@ public: * @tparam SimpleTlvType The simple TLV type to find (must be a sub-class of `SimpleTlvInfo`) * * @param[in] aMessage A reference to the message. - * @param[in] aType The TLV type to search for. * @param[out] aValue A reference to the value object to output the read value. * * @retval kErrorNone The TLV was found and read successfully. @p aValue is updated. diff --git a/src/core/mac/data_poll_sender.hpp b/src/core/mac/data_poll_sender.hpp index d491c275d..a30f56362 100644 --- a/src/core/mac/data_poll_sender.hpp +++ b/src/core/mac/data_poll_sender.hpp @@ -271,7 +271,7 @@ private: static constexpr uint32_t kRetxPollPeriod = OPENTHREAD_CONFIG_MAC_RETX_POLL_PERIOD; static constexpr uint32_t kFastPollPeriod = 188; static constexpr uint32_t kMinPollPeriod = OPENTHREAD_CONFIG_MAC_MINIMUM_POLL_PERIOD; - static constexpr uint32_t kMaxExternalPeriod = ((1 << 26) - 1); //< ~18.6 hours. + static constexpr uint32_t kMaxExternalPeriod = ((1 << 26) - 1); // ~18.6 hours. void ScheduleNextPoll(PollPeriodSelector aPollPeriodSelector); uint32_t CalculatePollPeriod(void) const; @@ -285,17 +285,17 @@ private: TimeMilli mTimerStartTime; uint32_t mPollPeriod; - uint32_t mExternalPollPeriod : 26; //< In milliseconds. - uint8_t mFastPollsUsers : 6; //< Number of callers which request fast polls. + uint32_t mExternalPollPeriod : 26; // In milliseconds. + uint8_t mFastPollsUsers : 6; // Number of callers which request fast polls. TimerMilli mTimer; - bool mEnabled : 1; //< Indicates whether data polling is enabled/started. - bool mAttachMode : 1; //< Indicates whether in attach mode (to use attach poll period). - bool mRetxMode : 1; //< Indicates whether last poll tx failed at mac/radio layer (poll retx mode). - uint8_t mPollTimeoutCounter : 4; //< Poll timeouts counter (0 to `kQuickPollsAfterTimout`). - uint8_t mPollTxFailureCounter : 4; //< Poll tx failure counter (0 to `kMaxPollRetxAttempts`). - uint8_t mRemainingFastPolls : 4; //< Number of remaining fast polls when in transient fast polling mode. + bool mEnabled : 1; // Indicates whether data polling is enabled/started. + bool mAttachMode : 1; // Indicates whether in attach mode (to use attach poll period). + bool mRetxMode : 1; // Indicates whether last poll tx failed at mac/radio layer (poll retx mode). + uint8_t mPollTimeoutCounter : 4; // Poll timeouts counter (0 to `kQuickPollsAfterTimout`). + uint8_t mPollTxFailureCounter : 4; // Poll tx failure counter (0 to `kMaxPollRetxAttempts`). + uint8_t mRemainingFastPolls : 4; // Number of remaining fast polls when in transient fast polling mode. }; /** diff --git a/src/core/mac/mac_frame.hpp b/src/core/mac/mac_frame.hpp index af26bfd1a..79dec45b6 100644 --- a/src/core/mac/mac_frame.hpp +++ b/src/core/mac/mac_frame.hpp @@ -93,7 +93,7 @@ public: /** * This method sets the IE Element Id. * - * @param[in] aID The IE Element Id. + * @param[in] aId The IE Element Id. * */ void SetId(uint16_t aId) @@ -155,7 +155,7 @@ public: /** * This method returns the Vendor OUI. * - * @returns the Vendor OUI. + * @returns The Vendor OUI. * */ uint32_t GetVendorOui(void) const { return ReadUint24(mOui); } @@ -171,7 +171,7 @@ public: /** * This method returns the Vendor IE sub-type. * - * @returns the Vendor IE sub-type. + * @returns The Vendor IE sub-type. * */ uint8_t GetSubType(void) const { return mSubType; } @@ -179,7 +179,7 @@ public: /** * This method sets the Vendor IE sub-type. * - * @param[in] the Vendor IE sub-type. + * @param[in] aSubType The Vendor IE sub-type. * */ void SetSubType(uint8_t aSubType) { mSubType = aSubType; } @@ -364,8 +364,8 @@ public: /** * This method initializes the MAC header. * - * @param[in] aFcf The Frame Control field. - * @param[in] aSecurityCtl The Security Control field. + * @param[in] aFcf The Frame Control field. + * @param[in] aSecurityControl The Security Control field. * */ void InitMacHeader(uint16_t aFcf, uint8_t aSecurityControl); @@ -663,7 +663,7 @@ public: /** * This method gets the Key Identifier Mode. * - * @param[out] aSecurityLevel The Key Identifier Mode. + * @param[out] aKeyIdMode The Key Identifier Mode. * * @retval kErrorNone Successfully retrieved the Key Identifier Mode. * diff --git a/src/core/mac/mac_types.hpp b/src/core/mac/mac_types.hpp index c28ff57d8..cd2802e31 100644 --- a/src/core/mac/mac_types.hpp +++ b/src/core/mac/mac_types.hpp @@ -523,7 +523,7 @@ public: /** * This method converts `KeyMaterial` to a `Crypto::Key`. * - * @param[out] A reference to a `Crypto::Key` to populate. + * @param[out] aCryptoKey A reference to a `Crypto::Key` to populate. * */ void ConvertToCryptoKey(Crypto::Key &aCryptoKey) const; diff --git a/src/core/meshcop/dataset.hpp b/src/core/meshcop/dataset.hpp index 2c8b27c54..0e2f0805b 100644 --- a/src/core/meshcop/dataset.hpp +++ b/src/core/meshcop/dataset.hpp @@ -406,7 +406,7 @@ public: /** * This method sets the Delay Timer in the Dataset. * - * @param[in] aDely A Delay value. + * @param[in] aDelay A Delay value. * */ void SetDelay(uint32_t aDelay) diff --git a/src/core/meshcop/dataset_updater.hpp b/src/core/meshcop/dataset_updater.hpp index c72c644ee..cd7a806bb 100644 --- a/src/core/meshcop/dataset_updater.hpp +++ b/src/core/meshcop/dataset_updater.hpp @@ -74,13 +74,6 @@ public: * * The function pointer has the syntax `void (*Callback)(Error aError, void *aContext)`. * - * @param[in] aError The error status. - * kErrorNone indicates Dataset update successfully finished. - * kErrorInvalidState indicates failure due invalid state (MLE being disabled). - * kErrorAlready indicates failure due to another device within network requesting a - * conflicting Dataset update. - * @param[in] aContext A pointer to the arbitrary context provided by the user. - * */ typedef otDatasetUpdaterCallback Callback; diff --git a/src/core/meshcop/dtls.hpp b/src/core/meshcop/dtls.hpp index dd16fdf23..0f809de75 100644 --- a/src/core/meshcop/dtls.hpp +++ b/src/core/meshcop/dtls.hpp @@ -72,7 +72,7 @@ public: /** * This constructor initializes the DTLS object. * - * @param[in] aNetif A reference to the Thread network interface. + * @param[in] aInstance A reference to the OpenThread instance. * @param[in] aLayerTwoSecurity Specifies whether to use layer two security or not. * */ diff --git a/src/core/meshcop/joiner_router.hpp b/src/core/meshcop/joiner_router.hpp index 206972b35..e8c61167a 100644 --- a/src/core/meshcop/joiner_router.hpp +++ b/src/core/meshcop/joiner_router.hpp @@ -78,7 +78,7 @@ public: /** * This method sets the Joiner UDP Port. * - * @param[in] The Joiner UDP Port number. + * @param[in] aJoinerUdpPort The Joiner UDP Port number. * */ void SetJoinerUdpPort(uint16_t aJoinerUdpPort); diff --git a/src/core/meshcop/meshcop.hpp b/src/core/meshcop/meshcop.hpp index 20a238fc6..508ec738c 100644 --- a/src/core/meshcop/meshcop.hpp +++ b/src/core/meshcop/meshcop.hpp @@ -205,7 +205,7 @@ public: /** * This method indicates whether a given Joiner ID matches the Discerner. * - * @param[in] aJoiner A Joiner ID to match with the Discerner. + * @param[in] aJoinerId A Joiner ID to match with the Discerner. * * @returns TRUE if the Joiner ID matches the Discerner, FALSE otherwise. * @@ -437,7 +437,7 @@ void ComputeJoinerId(const Mac::ExtAddress &aEui64, Mac::ExtAddress &aJoinerId); /** * This function gets the border agent RLOC. * - * @param[in] aNetif A reference to the thread interface. + * @param[in] aNetIf A reference to the thread interface. * @param[out] aRloc Border agent RLOC. * * @retval kErrorNone Successfully got the Border Agent Rloc. diff --git a/src/core/meshcop/meshcop_tlvs.hpp b/src/core/meshcop/meshcop_tlvs.hpp index 378319df9..3056aed9a 100644 --- a/src/core/meshcop/meshcop_tlvs.hpp +++ b/src/core/meshcop/meshcop_tlvs.hpp @@ -827,7 +827,7 @@ public: /** * This method sets the Border Agent Locator value. * - * @param[in] aBorderAgentLocator The Border Agent Locator value. + * @param[in] aLocator The Border Agent Locator value. * */ void SetBorderAgentLocator(uint16_t aLocator) { mLocator = HostSwap16(aLocator); } @@ -930,7 +930,7 @@ public: /** * This method sets the Commissioner Session ID value. * - * @param[in] aCommissionerSessionId The Commissioner Session ID value. + * @param[in] aSessionId The Commissioner Session ID value. * */ void SetCommissionerSessionId(uint16_t aSessionId) { mSessionId = HostSwap16(aSessionId); } @@ -1500,7 +1500,7 @@ public: /** * This method sets the Channel Mask Entries. * - * @param[in] aMask The Channel Mask value. + * @param[in] aChannelMask The Channel Mask value. * */ void SetChannelMask(uint32_t aChannelMask); diff --git a/src/core/net/dhcp6.hpp b/src/core/net/dhcp6.hpp index 2287e319b..6a1f3dac5 100644 --- a/src/core/net/dhcp6.hpp +++ b/src/core/net/dhcp6.hpp @@ -311,7 +311,7 @@ public: /** * This method sets the client LinkLayerAddress. * - * @param[in] aLinkLayerAddress The client LinkLayerAddress. + * @param[in] aDuidLinkLayerAddress The client LinkLayerAddress. * */ void SetDuidLinkLayerAddress(const Mac::ExtAddress &aDuidLinkLayerAddress) @@ -382,7 +382,7 @@ public: /** * This method sets the server LinkLayerAddress. * - * @param[in] aLinkLayerAddress The server LinkLayerAddress. + * @param[in] aDuidLinkLayerAddress The server LinkLayerAddress. * */ void SetDuidLinkLayerAddress(const Mac::ExtAddress &aDuidLinkLayerAddress) @@ -428,7 +428,7 @@ public: /** * This method sets the client IAID. * - * @param[in] aIaId The client IAID. + * @param[in] aIaid The client IAID. * */ void SetIaid(uint32_t aIaid) { mIaid = HostSwap32(aIaid); } diff --git a/src/core/net/dns_client.hpp b/src/core/net/dns_client.hpp index 85721030f..de9afca3d 100644 --- a/src/core/net/dns_client.hpp +++ b/src/core/net/dns_client.hpp @@ -391,7 +391,6 @@ public: * Note that this method gets the service instance label and not the full service instance name which is of the * form `..`. * - * @param[in] aResponse A pointer to a response. * @param[in] aIndex The service instance record index to retrieve. * @param[out] aLabelBuffer A char array to output the service instance label (MUST NOT be NULL). * @param[in] aLabelBufferSize The size of @p aLabelBuffer. @@ -668,7 +667,6 @@ public: * the config for this query. In a non-`nullptr` @p aConfig, some of the fields can be left unspecified (value * zero). The unspecified fields are then replaced by the values from the default config. * - * @param[in] aServerSockAddr The server socket address. * @param[in] aInstanceLabel The service instance label. * @param[in] aServiceName The service name (together with @p aInstanceLabel form full instance name). * @param[in] aCallback A function pointer that shall be called on response reception or time-out. diff --git a/src/core/net/dns_dso.hpp b/src/core/net/dns_dso.hpp index a8346c7e7..d9ff458cd 100644 --- a/src/core/net/dns_dso.hpp +++ b/src/core/net/dns_dso.hpp @@ -642,7 +642,7 @@ public: * `kMinKeepAliveInterval`, otherwise `kErrorInvalidArgs` is returned. * * @param[in] aInactivityTimeout The Inactivity timeout (in msec). - * @param[in] aKeepAliveTimeout The Keep Alive timeout (in msec). + * @param[in] aKeepAliveInterval The Keep Alive interval (in msec). * * @retval kErrorNone Successfully set the timeouts and sent a Keep Alive message. * @retval kErrorInvalidArgs The given timeouts are not valid. diff --git a/src/core/net/dnssd_server.hpp b/src/core/net/dnssd_server.hpp index b43e28188..2bab3b07e 100644 --- a/src/core/net/dnssd_server.hpp +++ b/src/core/net/dnssd_server.hpp @@ -147,8 +147,8 @@ public: /** * This method acquires the DNS-SD query type and name for a specific query. * - * @param[in] aQuery The query pointer. - * @param[out] aNameOutput The name output buffer. + * @param[in] aQuery The query pointer. + * @param[out] aName The name output buffer. * * @returns The DNS-SD query type. * diff --git a/src/core/net/icmp6.hpp b/src/core/net/icmp6.hpp index 08d592dc4..ba73d6093 100644 --- a/src/core/net/icmp6.hpp +++ b/src/core/net/icmp6.hpp @@ -307,9 +307,9 @@ public: otIcmp6EchoMode GetEchoMode(void) const { return mEchoMode; } /** - * This method sets whether or not ICMPv6 Echo processing is enabled. + * Sets the ICMPv6 echo mode. * - * @param[in] aEnabled TRUE to enable ICMPv6 Echo processing, FALSE otherwise. + * @param[in] aMode The ICMPv6 echo mode. * */ void SetEchoMode(otIcmp6EchoMode aMode) { mEchoMode = aMode; } diff --git a/src/core/net/ip6.hpp b/src/core/net/ip6.hpp index 48f570e86..26bea1155 100644 --- a/src/core/net/ip6.hpp +++ b/src/core/net/ip6.hpp @@ -301,7 +301,7 @@ public: /** * This static method converts an IP protocol number to a string. * - * @param[in] aIpPorto An IP protocol number. + * @param[in] aIpProto An IP protocol number. * * @returns The string representation of @p aIpProto. * diff --git a/src/core/net/srp_client.hpp b/src/core/net/srp_client.hpp index cf0524627..a24812888 100644 --- a/src/core/net/srp_client.hpp +++ b/src/core/net/srp_client.hpp @@ -422,7 +422,7 @@ public: * Changing the lease interval does not impact the accepted lease interval of already registered services/host-info. * It only changes any future SRP update messages (i.e adding new services and/or refreshes of existing services). * - * @param[in] The lease interval (in seconds). If zero, the default value `kDefaultLease` would be used. + * @param[in] aInterval The lease interval (in seconds). If zero, the default value `kDefaultLease` would be used. * */ void SetLeaseInterval(uint32_t aInterval) { mLeaseInterval = GetBoundedLeaseInterval(aInterval, kDefaultLease); } @@ -441,7 +441,8 @@ public: * Changing the lease interval does not impact the accepted lease interval of already registered services/host-info. * It only changes any future SRP update messages (i.e adding new services and/or refreshes of existing services). * - * @param[in] The key lease interval (in seconds). If zero, the default value `kDefaultKeyLease` would be used. + * @param[in] aInterval The key lease interval (in seconds). If zero, the default value `kDefaultKeyLease` would be + * used. * */ void SetKeyLeaseInterval(uint32_t aInterval) @@ -576,9 +577,9 @@ public: * any previously registered services with the server. In this case, caller can `SetHostName()` and then request * `RemoveHostAndServices()` with `aSendUnregToServer` as `true`. * - * @param[in] aRemoveKeyLease A boolean indicating whether or not the host key lease should also be removed. - * @param[in] aSendUnregToServer A boolean indicating whether to send update to server when host info is not - * registered. + * @param[in] aShouldRemoveKeyLease A boolean indicating whether or not the host key lease should also be removed. + * @param[in] aSendUnregToServer A boolean indicating whether to send update to server when host info is not + * registered. * * @retval kErrorNone The removal of host and services started successfully. The `Callback` will be called * to report the status. diff --git a/src/core/net/srp_server.hpp b/src/core/net/srp_server.hpp index e86284cd6..50245d789 100644 --- a/src/core/net/srp_server.hpp +++ b/src/core/net/srp_server.hpp @@ -272,8 +272,6 @@ public: /** * This method returns the priority of the service instance. * - * @param[in] aService A pointer to the SRP service. - * * @returns The priority of the service. * */ diff --git a/src/core/net/udp6.hpp b/src/core/net/udp6.hpp index d7ea7dcde..a628834ed 100644 --- a/src/core/net/udp6.hpp +++ b/src/core/net/udp6.hpp @@ -306,8 +306,8 @@ public: /** * This constructor initializes the UDP receiver. * - * @param[in] aUdpHandler A pointer to the function to handle UDP message. - * @param[in] aContext A pointer to arbitrary context information. + * @param[in] aHandler A pointer to the function to handle UDP message. + * @param[in] aContext A pointer to arbitrary context information. * */ Receiver(otUdpHandler aHandler, void *aContext) diff --git a/src/core/radio/radio.hpp b/src/core/radio/radio.hpp index fd8e56143..2e2ef8893 100644 --- a/src/core/radio/radio.hpp +++ b/src/core/radio/radio.hpp @@ -163,8 +163,7 @@ public: * This method is used when radio provides OT_RADIO_CAPS_ENERGY_SCAN capability. It is called from * `otPlatRadioEnergyScanDone()`. * - * @param[in] aInstance The OpenThread instance structure. - * @param[in] aEnergyScanMaxRssi The maximum RSSI encountered on the scanned channel. + * @param[in] aMaxRssi The maximum RSSI encountered on the scanned channel. * */ void HandleEnergyScanDone(int8_t aMaxRssi); @@ -476,8 +475,6 @@ public: /** * Get the current uncertainty, in units of 10 us, of the clock used for scheduling CSL operations. * - * @param[in] aInstance A pointer to an OpenThread instance. - * * @returns The current CSL Clock Uncertainty in units of 10 us. * */ @@ -630,12 +627,11 @@ public: * starts/stops to collect Link Metrics data and include Vendor-Specific IE that containing the data * in Enhanced-ACK sent to that Probing Initiator. * - * @param[in] aInstance The OpenThread instance structure. - * @param[in] aDataLength Length of Link Metrics data in the Vendor-Specific IE. Per spec 4.11.3.4.4.6, - * @p aDataLength should only be 1 or 2. The probing would be disabled if `aDataLength` is - * `0`. - * @param[in] aShortAddr The short address of the the probing Initiator. - * @param[in] aExtAddr The extended source address of the probing Initiator. + * @param[in] aLinkMetrics This parameter specifies what metrics to query. Per spec 4.11.3.4.4.6, at most 2 + * metrics can be specified. The probing would be disabled if @p `aLinkMetrics` is + * bitwise 0. + * @param[in] aShortAddress The short address of the the probing Initiator. + * @param[in] aExtAddress The extended source address of the probing Initiator. * * @retval kErrorNone Successfully enable/disable or update Enhanced-ACK Based Probing for a specific * Initiator. diff --git a/src/core/thread/child_table.hpp b/src/core/thread/child_table.hpp index 70a49ce75..93cdfe00b 100644 --- a/src/core/thread/child_table.hpp +++ b/src/core/thread/child_table.hpp @@ -276,7 +276,7 @@ public: /** * This method removes a stored child information from non-volatile memory. * - * @param[in] aChildRloc16 A reference to the child to remove from non-volatile memory. + * @param[in] aChild A reference to the child to remove from non-volatile memory. * */ void RemoveStoredChild(const Child &aChild); diff --git a/src/core/thread/discover_scanner.hpp b/src/core/thread/discover_scanner.hpp index bd1822ce1..d854a1975 100644 --- a/src/core/thread/discover_scanner.hpp +++ b/src/core/thread/discover_scanner.hpp @@ -113,7 +113,7 @@ public: * @param[in] aFilterIndexes A pointer to `FilterIndexes` to use for filtering (when enabled). * If set to `nullptr`, filter indexes are derived from hash of factory-assigned * EUI64. - * @param[in] aHandler A pointer to a function that is called on receiving an MLE Discovery Response. + * @param[in] aCallback A pointer to a function that is called on receiving an MLE Discovery Response. * @param[in] aContext A pointer to arbitrary context information. * * @retval kErrorNone Successfully started a Thread Discovery Scan. diff --git a/src/core/thread/link_metrics.hpp b/src/core/thread/link_metrics.hpp index f1891af88..318aea0e6 100644 --- a/src/core/thread/link_metrics.hpp +++ b/src/core/thread/link_metrics.hpp @@ -402,7 +402,7 @@ public: * This method processes received Enh-ACK Probing IE data. * * @param[in] aData A pointer to buffer containing the Enh-ACK Probing IE data. - * @param[in] aLen The length of @p aData. + * @param[in] aLength The length of @p aData. * @param[in] aNeighbor The neighbor from which the Enh-ACK Probing IE was received. * */ diff --git a/src/core/thread/link_metrics_tlvs.hpp b/src/core/thread/link_metrics_tlvs.hpp index 10f9f0bce..118f730be 100644 --- a/src/core/thread/link_metrics_tlvs.hpp +++ b/src/core/thread/link_metrics_tlvs.hpp @@ -329,7 +329,7 @@ public: /** * This method sets the Link Metrics Type ID. * - * @param[in] aMetricsTypeID The Link Metrics Type ID to set. + * @param[in] aMetricsTypeId The Link Metrics Type ID to set. * */ void SetMetricsTypeId(TypeIdFlags aMetricsTypeId) diff --git a/src/core/thread/lowpan.hpp b/src/core/thread/lowpan.hpp index 7eab56fd9..ae42d1e80 100644 --- a/src/core/thread/lowpan.hpp +++ b/src/core/thread/lowpan.hpp @@ -279,12 +279,12 @@ public: /** * This method decompresses a LOWPAN_IPHC header. * - * @param[out] aIp6Header A reference where the IPv6 header will be placed. - * @param[out] aCommpressedNextHeader A boolean reference to output whether next header is compressed or not. - * @param[in] aMacSource The MAC source address. - * @param[in] aMacDest The MAC destination address. - * @param[in] aBuf A pointer to the LOWPAN_IPHC header. - * @param[in] aBufLength The number of bytes in @p aBuf. + * @param[out] aIp6Header A reference where the IPv6 header will be placed. + * @param[out] aCompressedNextHeader A boolean reference to output whether next header is compressed or not. + * @param[in] aMacSource The MAC source address. + * @param[in] aMacDest The MAC destination address. + * @param[in] aBuf A pointer to the LOWPAN_IPHC header. + * @param[in] aBufLength The number of bytes in @p aBuf. * * @returns The size of the compressed header in bytes or -1 if decompression fails. * diff --git a/src/core/thread/mle.hpp b/src/core/thread/mle.hpp index 8fc1ccd11..00537696d 100644 --- a/src/core/thread/mle.hpp +++ b/src/core/thread/mle.hpp @@ -1086,9 +1086,9 @@ protected: * Frame Counter TLV is present in the message, its value is read into @p aMleFrameCounter. If the MLE Frame * Counter TLV is not present in the message, then @p aMleFrameCounter is set to same value as @p aLinkFrameCounter. * - * @param[in] aMesssage A reference to the message to read from. - * @param[out] aLinkFrameCounter A reference to an `uint32_t` to output the Link Frame Counter. - * @param[out] aMleFrameCounter A reference to an `uint32_t` to output the MLE Frame Counter. + * @param[in] aMessage A reference to the message to read from. + * @param[out] aLinkFrameCounter A reference to an `uint32_t` to output the Link Frame Counter. + * @param[out] aMleFrameCounter A reference to an `uint32_t` to output the MLE Frame Counter. * * @retval kErrorNone Successfully read the counters. * @retval kErrorNotFound Link Frame Counter TLV was not found in the message. diff --git a/src/core/thread/mle_router.hpp b/src/core/thread/mle_router.hpp index f35a36c6a..362e76bfb 100644 --- a/src/core/thread/mle_router.hpp +++ b/src/core/thread/mle_router.hpp @@ -303,7 +303,7 @@ public: /** * This method sets the ROUTER_UPGRADE_THRESHOLD value. * - * @returns The ROUTER_UPGRADE_THRESHOLD value. + * @param[in] aThreshold The ROUTER_UPGRADE_THRESHOLD value. * */ void SetRouterUpgradeThreshold(uint8_t aThreshold) { mRouterUpgradeThreshold = aThreshold; } @@ -319,7 +319,7 @@ public: /** * This method sets the ROUTER_DOWNGRADE_THRESHOLD value. * - * @returns The ROUTER_DOWNGRADE_THRESHOLD value. + * @param[in] aThreshold The ROUTER_DOWNGRADE_THRESHOLD value. * */ void SetRouterDowngradeThreshold(uint8_t aThreshold) { mRouterDowngradeThreshold = aThreshold; } diff --git a/src/core/thread/network_data.cpp b/src/core/thread/network_data.cpp index 31bb8c809..e0946e28b 100644 --- a/src/core/thread/network_data.cpp +++ b/src/core/thread/network_data.cpp @@ -328,7 +328,7 @@ bool NetworkData::ContainsService(const ServiceConfig &aService) const return contains; } -bool NetworkData::ContainsEntriesFrom(const NetworkData &aComapre, uint16_t aRloc16) const +bool NetworkData::ContainsEntriesFrom(const NetworkData &aCompare, uint16_t aRloc16) const { bool contains = true; Iterator iterator = kIteratorInit; @@ -344,7 +344,7 @@ bool NetworkData::ContainsEntriesFrom(const NetworkData &aComapre, uint16_t aRlo config.mExternalRoute = &route; config.mService = &service; - SuccessOrExit(aComapre.Iterate(iterator, aRloc16, config)); + SuccessOrExit(aCompare.Iterate(iterator, aRloc16, config)); if (((config.mOnMeshPrefix != nullptr) && !ContainsOnMeshPrefix(*config.mOnMeshPrefix)) || ((config.mExternalRoute != nullptr) && !ContainsExternalRoute(*config.mExternalRoute)) || diff --git a/src/core/thread/network_data.hpp b/src/core/thread/network_data.hpp index 3dc80d892..3dbe1f004 100644 --- a/src/core/thread/network_data.hpp +++ b/src/core/thread/network_data.hpp @@ -310,7 +310,7 @@ public: * @retval FALSE if Network Data does not contains all the same entries as in @p aCompare for @p aRloc16. * */ - bool ContainsEntriesFrom(const NetworkData &aComapre, uint16_t aRloc16) const; + bool ContainsEntriesFrom(const NetworkData &aCompare, uint16_t aRloc16) const; /** * This method provides the next server RLOC16 in the Thread Network Data. diff --git a/src/core/thread/network_data_tlvs.hpp b/src/core/thread/network_data_tlvs.hpp index 2fd372ed9..48568c7d7 100644 --- a/src/core/thread/network_data_tlvs.hpp +++ b/src/core/thread/network_data_tlvs.hpp @@ -1214,17 +1214,17 @@ public: /** * This method initializes the Context TLV. * - * @param[in] aConextId The Context ID value. - * @param[in] aLength The Context Length value. + * @param[in] aContextId The Context ID value. + * @param[in] aContextLength The Context Length value. * */ - void Init(uint8_t aContextId, uint8_t aConextLength) + void Init(uint8_t aContextId, uint8_t aContextLength) { NetworkDataTlv::Init(); SetType(kTypeContext); SetLength(sizeof(ContextTlv) - sizeof(NetworkDataTlv)); mFlags = ((aContextId << kContextIdOffset) & kContextIdMask); - mContextLength = aConextLength; + mContextLength = aContextLength; } /** diff --git a/src/core/thread/topology.hpp b/src/core/thread/topology.hpp index 0859a7be0..7c6ac7efb 100644 --- a/src/core/thread/topology.hpp +++ b/src/core/thread/topology.hpp @@ -694,7 +694,7 @@ public: /** * This method adds a new LinkMetrics::SeriesInfo to the neighbor's list. * - * @param[in] A reference to the new SeriesInfo. + * @param[in] aSeriesInfo A reference to the new SeriesInfo. * */ void AddForwardTrackingSeriesInfo(LinkMetrics::SeriesInfo &aSeriesInfo); @@ -1435,7 +1435,7 @@ public: /** * This method sets the CSL clock accuracy of this router. * - * @param[in] aCost The CSL clock accuracy of this router. + * @param[in] aCslClockAccuracy The CSL clock accuracy of this router. * */ void SetCslClockAccuracy(uint8_t aCslClockAccuracy) { mCslClockAccuracy = aCslClockAccuracy; } @@ -1451,7 +1451,7 @@ public: /** * This method sets the CSL clock uncertainty of this router. * - * @param[in] aCost The CSL clock uncertainty of this router. + * @param[in] aCslClockUncertainty The CSL clock uncertainty of this router. * */ void SetCslClockUncertainty(uint8_t aCslClockUncertainty) { mCslClockUncertainty = aCslClockUncertainty; } diff --git a/src/core/utils/jam_detector.hpp b/src/core/utils/jam_detector.hpp index 02bb5f279..98dc5e2a6 100644 --- a/src/core/utils/jam_detector.hpp +++ b/src/core/utils/jam_detector.hpp @@ -111,7 +111,7 @@ public: /** * Set the Jam Detection RSSI Threshold (in dBm). * - * @param[in] aRssiThreshold The RSSI threshold. + * @param[in] aThreshold The RSSI threshold. * */ void SetRssiThreshold(int8_t aThreshold); diff --git a/src/lib/spinel/spinel_buffer.hpp b/src/lib/spinel/spinel_buffer.hpp index 056034b3b..6377a1f82 100644 --- a/src/lib/spinel/spinel_buffer.hpp +++ b/src/lib/spinel/spinel_buffer.hpp @@ -61,8 +61,8 @@ public: */ enum Priority { - kPriorityLow = 0, //< Indicates low/normal priority for a frame. - kPriorityHigh = 1, //< Indicates high priority for a frame. + kPriorityLow = 0, ///< Indicates low/normal priority for a frame. + kPriorityHigh = 1, ///< Indicates high priority for a frame. }; /** @@ -98,8 +98,8 @@ public: } private: - uint8_t *mPosition; //< Pointer into buffer corresponding to saved write position. - uint8_t *mSegmentHead; //< Pointer to segment head. + uint8_t *mPosition; // Pointer into buffer corresponding to saved write position. + uint8_t *mSegmentHead; // Pointer to segment head. friend class Buffer; }; diff --git a/src/lib/spinel/spinel_decoder.hpp b/src/lib/spinel/spinel_decoder.hpp index 77328d70b..bdd386198 100644 --- a/src/lib/spinel/spinel_decoder.hpp +++ b/src/lib/spinel/spinel_decoder.hpp @@ -471,7 +471,7 @@ public: * * @param[out] aData Reference to pointer variable to output the data. * On success, the pointer variable is updated. - * @param[out] aDataLength Reference to variable to output the data length (number of bytes). + * @param[out] aDataLen Reference to variable to output the data length (number of bytes). * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value. @@ -488,7 +488,7 @@ public: * * @param[out] aData Reference to pointer variable to output the data. * On success, the pointer variable is updated. - * @param[out] aDataLength Reference to variable to out the data length (number of bytes). + * @param[out] aDataLen Reference to variable to out the data length (number of bytes). * * @retval OT_ERROR_NONE Successfully read the value. * @retval OT_ERROR_PARSE Failed to parse/decode the value. diff --git a/src/lib/spinel/spinel_encoder.hpp b/src/lib/spinel/spinel_encoder.hpp index 44ea0781b..079005433 100644 --- a/src/lib/spinel/spinel_encoder.hpp +++ b/src/lib/spinel/spinel_encoder.hpp @@ -435,7 +435,7 @@ public: * If no buffer space is available, this method will discard and clear the current input frame and return the * error status `OT_ERROR_NO_BUFS`. * - * @param[in] aExtAddress A pointer to a buffer containing the EUI64 value. + * @param[in] aEui64 A pointer to a buffer containing the EUI64 value. * * @retval OT_ERROR_NONE Successfully added given value to the frame. * @retval OT_ERROR_NO_BUFS Insufficient buffer space available to add the EUI64 value.