mirror of
https://github.com/espressif/openthread.git
synced 2026-09-04 08:10:11 +00:00
[docs] remove redundant "This method" and "This function" (#9096)
- "This method " - "This static method " - "This function " - "This structure " - "This enumeration " - "This class " - "This methods " - "This constructor " - "This struct " - "This type " - "This template method " - "This template class " - "This const method " - "This macro "
This commit is contained in:
Jonathan Hui
@@ -99,7 +99,7 @@ void TestIphcVector::GetUncompressedStream(Message &aMessage)
|
||||
}
|
||||
|
||||
/**
|
||||
* This function initializes Thread Interface.
|
||||
* Initializes Thread Interface.
|
||||
*
|
||||
*/
|
||||
static void Init(void)
|
||||
@@ -134,7 +134,7 @@ static void Init(void)
|
||||
}
|
||||
|
||||
/**
|
||||
* This function performs compression or/and decompression based on the given test vector.
|
||||
* Performs compression or/and decompression based on the given test vector.
|
||||
*
|
||||
* @note Performing decompression and compression on the same LOWPAN_IPHC frame may give different result.
|
||||
* This situation may occur when sender does not use the best possible compression,
|
||||
|
||||
+16
-16
@@ -68,7 +68,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* This method sets long MAC source address.
|
||||
* Sets long MAC source address.
|
||||
*
|
||||
* @param aAddress Pointer to the long MAC address.
|
||||
*
|
||||
@@ -76,7 +76,7 @@ public:
|
||||
void SetMacSource(const uint8_t *aAddress) { mMacAddrs.mSource.SetExtended(aAddress); }
|
||||
|
||||
/**
|
||||
* This method sets short MAC source address.
|
||||
* Sets short MAC source address.
|
||||
*
|
||||
* @param aAddress Short MAC address.
|
||||
*
|
||||
@@ -84,7 +84,7 @@ public:
|
||||
void SetMacSource(uint16_t aAddress) { mMacAddrs.mSource.SetShort(aAddress); }
|
||||
|
||||
/**
|
||||
* This method sets long MAC destination address.
|
||||
* Sets long MAC destination address.
|
||||
*
|
||||
* @param aAddress Pointer to the long MAC address.
|
||||
*
|
||||
@@ -92,7 +92,7 @@ public:
|
||||
void SetMacDestination(const uint8_t *aAddress) { mMacAddrs.mDestination.SetExtended(aAddress); }
|
||||
|
||||
/**
|
||||
* This method sets short MAC destination address.
|
||||
* Sets short MAC destination address.
|
||||
*
|
||||
* @param aAddress Short MAC address.
|
||||
*
|
||||
@@ -100,7 +100,7 @@ public:
|
||||
void SetMacDestination(uint16_t aAddress) { mMacAddrs.mDestination.SetShort(aAddress); }
|
||||
|
||||
/**
|
||||
* This method gets the IPv6 header
|
||||
* Gets the IPv6 header
|
||||
*
|
||||
* @returns the IPv6 header.
|
||||
*
|
||||
@@ -108,7 +108,7 @@ public:
|
||||
const Ip6::Header &GetIpHeader(void) const { return mIpHeader; }
|
||||
|
||||
/**
|
||||
* This method initializes IPv6 Header.
|
||||
* Initializes IPv6 Header.
|
||||
*
|
||||
* @param aVersionClassFlow Value of the Version, Traffic class and Flow control fields.
|
||||
* @param aPayloadLength Value of the payload length field.
|
||||
@@ -134,7 +134,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* This method initializes IPv6 Encapsulated Header.
|
||||
* Initializes IPv6 Encapsulated Header.
|
||||
*
|
||||
* @param aVersionClassFlow Value of the Version, Traffic class and Flow control fields.
|
||||
* @param aPayloadLength Value of the payload length field.
|
||||
@@ -160,7 +160,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* This method initializes IPv6 Extension Header.
|
||||
* Initializes IPv6 Extension Header.
|
||||
*
|
||||
* @param aExtHeader Pointer to the extension header data.
|
||||
* @param aExtHeaderLength Length of the extension header data.
|
||||
@@ -173,7 +173,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* This method initializes UDP Header.
|
||||
* Initializes UDP Header.
|
||||
*
|
||||
* @param aSource Value of the source port.
|
||||
* @param aDestination Value of the destination port.
|
||||
@@ -190,7 +190,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* This method initializes LOWPAN_IPHC Header.
|
||||
* Initializes LOWPAN_IPHC Header.
|
||||
*
|
||||
* @param aIphc Pointer to the LOWPAN_IPHC header.
|
||||
* @param aIphcLength Length of the LOWPAN_IPHC header.
|
||||
@@ -203,7 +203,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* This method sets the expect result of the compression / decompression procedure.
|
||||
* Sets the expect result of the compression / decompression procedure.
|
||||
*
|
||||
* @param aError Expected result.
|
||||
*
|
||||
@@ -211,7 +211,7 @@ public:
|
||||
void SetError(Error aError) { mError = aError; }
|
||||
|
||||
/**
|
||||
* This method initializes IPv6 Payload (uncompressed data).
|
||||
* Initializes IPv6 Payload (uncompressed data).
|
||||
*
|
||||
* @param aPayload Pointer to the payload data.
|
||||
* @param aLength Length of the payload data.
|
||||
@@ -224,7 +224,7 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* This method sets the offset from the beginning of the IPv6 header to the uncompressed
|
||||
* Sets the offset from the beginning of the IPv6 header to the uncompressed
|
||||
* payload.
|
||||
*
|
||||
* @param aPayloadOffset The offset from the beginning of the IPv6 header to the uncompressed
|
||||
@@ -234,7 +234,7 @@ public:
|
||||
void SetPayloadOffset(uint16_t aPayloadOffset) { mPayloadOffset = aPayloadOffset; }
|
||||
|
||||
/**
|
||||
* This method returns compressed LOWPAN_IPHC frame.
|
||||
* Returns compressed LOWPAN_IPHC frame.
|
||||
*
|
||||
* @returns The compressed stream.
|
||||
*
|
||||
@@ -242,7 +242,7 @@ public:
|
||||
void GetCompressedStream(uint8_t *aIphc, uint16_t &aIphcLength);
|
||||
|
||||
/**
|
||||
* This method returns message object with the uncompressed IPv6 packet.
|
||||
* Returns message object with the uncompressed IPv6 packet.
|
||||
*
|
||||
* @returns The message object with the uncompressed IPv6 packet.
|
||||
*
|
||||
@@ -250,7 +250,7 @@ public:
|
||||
void GetUncompressedStream(Message &aMessage);
|
||||
|
||||
/**
|
||||
* This method returns data with the uncompressed IPv6 packet.
|
||||
* Returns data with the uncompressed IPv6 packet.
|
||||
*
|
||||
* @returns The data with the uncompressed IPv6 packet.
|
||||
*
|
||||
|
||||
@@ -39,7 +39,7 @@ extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* This macro verifies a given error status to be successful (compared against value zero (0)), otherwise, it emits a
|
||||
* Verifies a given error status to be successful (compared against value zero (0)), otherwise, it emits a
|
||||
* given error messages and exits the program.
|
||||
*
|
||||
* @param[in] aStatus A scalar error status to be evaluated against zero (0).
|
||||
@@ -58,7 +58,7 @@ extern "C" {
|
||||
} while (false)
|
||||
|
||||
/**
|
||||
* This macro verifies that a given boolean condition is true, otherwise, it emits a given error message and exits the
|
||||
* Verifies that a given boolean condition is true, otherwise, it emits a given error message and exits the
|
||||
* program.
|
||||
*
|
||||
* @param[in] aCondition A Boolean expression to be evaluated.
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
#include "test_util.h"
|
||||
|
||||
/**
|
||||
* This function prints the content of a given buffer to screen as a hex dump along with ASCII text translation.
|
||||
* Prints the content of a given buffer to screen as a hex dump along with ASCII text translation.
|
||||
*
|
||||
* @param[in] aTextMessag A text message to describe the buffer content (printed before the buffer content)
|
||||
* @param[in] aBuffer A pointer to the buffer
|
||||
|
||||
Reference in New Issue
Block a user