diff --git a/src/core/backbone_router/bbr_leader.hpp b/src/core/backbone_router/bbr_leader.hpp index d79306043..6e8d182c5 100644 --- a/src/core/backbone_router/bbr_leader.hpp +++ b/src/core/backbone_router/bbr_leader.hpp @@ -135,7 +135,8 @@ public: /** * This method indicates whether or not there is Primary Backbone Router. * - * @retval TRUE if there is Primary Backbone Router, FALSE otherwise. + * @retval TRUE If there is Primary Backbone Router. + * @retval FALSE If there is no Primary Backbone Router. * */ bool HasPrimary(void) const { return mConfig.mServer16 != Mac::kShortAddrInvalid; } @@ -154,7 +155,8 @@ public: /** * This method indicates whether or not the Domain Prefix is available in the Thread Network. * - * @retval TRUE if there is Domain Prefix, FALSE otherwise. + * @retval TRUE If there is Domain Prefix. + * @retval FALSE If there is no Domain Prefix. * */ bool HasDomainPrefix(void) const { return (mDomainPrefix.GetLength() > 0); } diff --git a/src/core/mac/mac.hpp b/src/core/mac/mac.hpp index 88262a3a6..f97222f1c 100644 --- a/src/core/mac/mac.hpp +++ b/src/core/mac/mac.hpp @@ -168,7 +168,8 @@ public: /** * This method indicates whether or not IEEE 802.15.4 Beacon transmissions are enabled. * - * @retval TRUE if IEEE 802.15.4 Beacon transmissions are enabled, FALSE otherwise. + * @retval TRUE If IEEE 802.15.4 Beacon transmissions are enabled. + * @retval FALSE If IEEE 802.15.4 Beacon transmissions are not enabled. * */ bool IsBeaconEnabled(void) const { return mBeaconsEnabled; } @@ -697,7 +698,8 @@ public: /** * This method indicates whether CSL is started at the moment. * - * @retval TURE if CSL is actually running at the moment, FALSE otherwise. + * @retval TRUE If CSL is enabled. + * @retval FALSE If CSL is not enabled. * */ bool IsCslEnabled(void) const; @@ -705,7 +707,8 @@ public: /** * This method indicates whether Link is capable of starting CSL. * - * @retval TURE if Link is capable of starting CSL, FALSE otherwise. + * @retval TRUE If Link is capable of starting CSL. + * @retval FALSE If link is not capable of starting CSL. * */ bool IsCslCapable(void) const; diff --git a/src/core/mac/mac_frame.hpp b/src/core/mac/mac_frame.hpp index 4bd6136e3..ec111a76f 100644 --- a/src/core/mac/mac_frame.hpp +++ b/src/core/mac/mac_frame.hpp @@ -353,8 +353,8 @@ public: /** * This method indicates whether the frame is empty (no payload). * - * @retval TRUE The frame is empty (no PSDU payload). - * @retval FALSE The frame is not empty. + * @retval TRUE The frame is empty (no PSDU payload). + * @retval FALSE The frame is not empty. * */ bool IsEmpty(void) const { return (mLength == 0); } @@ -517,7 +517,8 @@ public: /** * This method indicates whether or not the Destination Address is present for this object. * - * @retval TRUE if the Destination Address is present, FALSE otherwise. + * @retval TRUE If the Destination Address is present. + * @retval FALSE If the Destination Address is not present. * */ bool IsDstAddrPresent() const { return IsDstAddrPresent(GetFrameControlField()); } @@ -559,7 +560,8 @@ public: /** * This method indicates whether or not the Source Address is present for this object. * - * @retval TRUE if the Source Address is present, FALSE otherwise. + * @retval TRUE If the Source Address is present. + * @retval FALSE If the Source Address is not present. * */ bool IsSrcPanIdPresent(void) const { return IsSrcPanIdPresent(GetFrameControlField()); } @@ -587,7 +589,8 @@ public: /** * This method indicates whether or not the Source Address is present for this object. * - * @retval TRUE if the Source Address is present, FALSE otherwise. + * @retval TRUE If the Source Address is present. + * @retval FALSE If the Source Address is not present. * */ bool IsSrcAddrPresent(void) const { return IsSrcAddrPresent(GetFrameControlField()); } @@ -1263,8 +1266,8 @@ public: /** * This method indicates whether or not CSMA-CA is enabled. * - * @retval TRUE CSMA-CA is enabled. - * @retval FALSE CSMA-CA is not enabled is not enabled. + * @retval TRUE CSMA-CA is enabled. + * @retval FALSE CSMA-CA is not enabled is not enabled. * */ bool IsCsmaCaEnabled(void) const { return mInfo.mTxInfo.mCsmaCaEnabled; } @@ -1432,8 +1435,8 @@ public: /** * This method indicates whether or not the beacon appears to be a valid Thread Beacon message. * - * @retval TRUE if the beacon appears to be a valid Thread Beacon message. - * @retval FALSE if the beacon does not appear to be a valid Thread Beacon message. + * @retval TRUE If the beacon appears to be a valid Thread Beacon message. + * @retval FALSE If the beacon does not appear to be a valid Thread Beacon message. * */ bool IsValid(void) const @@ -1499,8 +1502,8 @@ public: /** * This method indicates whether or not the beacon appears to be a valid Thread Beacon Payload. * - * @retval TRUE if the beacon appears to be a valid Thread Beacon Payload. - * @retval FALSE if the beacon does not appear to be a valid Thread Beacon Payload. + * @retval TRUE If the beacon appears to be a valid Thread Beacon Payload. + * @retval FALSE If the beacon does not appear to be a valid Thread Beacon Payload. * */ bool IsValid(void) const { return (mProtocolId == kProtocolId); } @@ -1524,8 +1527,8 @@ public: /** * This method indicates whether or not the Native Commissioner flag is set. * - * @retval TRUE if the Native Commissioner flag is set. - * @retval FALSE if the Native Commissioner flag is not set. + * @retval TRUE If the Native Commissioner flag is set. + * @retval FALSE If the Native Commissioner flag is not set. * */ bool IsNative(void) const { return (mFlags & kNativeFlag) != 0; } @@ -1545,8 +1548,8 @@ public: /** * This method indicates whether or not the Joining Permitted flag is set. * - * @retval TRUE if the Joining Permitted flag is set. - * @retval FALSE if the Joining Permitted flag is not set. + * @retval TRUE If the Joining Permitted flag is set. + * @retval FALSE If the Joining Permitted flag is not set. * */ bool IsJoiningPermitted(void) const { return (mFlags & kJoiningFlag) != 0; }