diff options
| author | eric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-09-09 06:22:30 +0000 |
|---|---|---|
| committer | eric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-09-09 06:22:30 +0000 |
| commit | 1106ffe1c04bfb1984d3233bd156d2b975429625 (patch) | |
| tree | ab6961c275f5af15eb7d5fca12008281490bf069 /MdePkg/Library/BaseLib/CheckSum.c | |
| parent | c0a23f8c370ad671fa8c67cf5047e9f8df5306c6 (diff) | |
| download | edk2-1106ffe1c04bfb1984d3233bd156d2b975429625.tar.gz edk2-1106ffe1c04bfb1984d3233bd156d2b975429625.tar.bz2 edk2-1106ffe1c04bfb1984d3233bd156d2b975429625.zip | |
Function description in baselib.h is not clear. change it to comply with Doxgen format.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5862 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Library/BaseLib/CheckSum.c')
| -rw-r--r-- | MdePkg/Library/BaseLib/CheckSum.c | 33 |
1 files changed, 16 insertions, 17 deletions
diff --git a/MdePkg/Library/BaseLib/CheckSum.c b/MdePkg/Library/BaseLib/CheckSum.c index 8612c7c392..78ff00c451 100644 --- a/MdePkg/Library/BaseLib/CheckSum.c +++ b/MdePkg/Library/BaseLib/CheckSum.c @@ -31,8 +31,8 @@ If Buffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
- @param Buffer Pointer to the buffer to carry out the sum operation.
- @param Length The size, in bytes, of Buffer .
+ @param Buffer Pointer to the buffer to carry out the sum operation.
+ @param Length The size, in bytes, of Buffer .
@return Sum The sum of Buffer with carry bits dropped during additions.
@@ -70,9 +70,8 @@ CalculateSum8 ( If Buffer is NULL, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
-
- @param Buffer Pointer to the buffer to carry out the checksum operation.
- @param Length The size, in bytes, of Buffer.
+ @param Buffer Pointer to the buffer to carry out the checksum operation.
+ @param Length The size, in bytes, of Buffer.
@return Checksum The 2's complement checksum of Buffer.
@@ -107,8 +106,8 @@ CalculateCheckSum8 ( If Length is not aligned on a 16-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
- @param Buffer Pointer to the buffer to carry out the sum operation.
- @param Length The size, in bytes, of Buffer.
+ @param Buffer Pointer to the buffer to carry out the sum operation.
+ @param Length The size, in bytes, of Buffer.
@return Sum The sum of Buffer with carry bits dropped during additions.
@@ -152,8 +151,8 @@ CalculateSum16 ( If Length is not aligned on a 16-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
- @param Buffer Pointer to the buffer to carry out the checksum operation.
- @param Length The size, in bytes, of Buffer.
+ @param Buffer Pointer to the buffer to carry out the checksum operation.
+ @param Length The size, in bytes, of Buffer.
@return Checksum The 2's complement checksum of Buffer.
@@ -189,8 +188,8 @@ CalculateCheckSum16 ( If Length is not aligned on a 32-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
- @param Buffer Pointer to the buffer to carry out the sum operation.
- @param Length The size, in bytes, of Buffer.
+ @param Buffer Pointer to the buffer to carry out the sum operation.
+ @param Length The size, in bytes, of Buffer.
@return Sum The sum of Buffer with carry bits dropped during additions.
@@ -234,8 +233,8 @@ CalculateSum32 ( If Length is not aligned on a 32-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
- @param Buffer Pointer to the buffer to carry out the checksum operation.
- @param Length The size, in bytes, of Buffer.
+ @param Buffer Pointer to the buffer to carry out the checksum operation.
+ @param Length The size, in bytes, of Buffer.
@return Checksum The 2's complement checksum of Buffer.
@@ -271,8 +270,8 @@ CalculateCheckSum32 ( If Length is not aligned on a 64-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
- @param Buffer Pointer to the buffer to carry out the sum operation.
- @param Length The size, in bytes, of Buffer.
+ @param Buffer Pointer to the buffer to carry out the sum operation.
+ @param Length The size, in bytes, of Buffer.
@return Sum The sum of Buffer with carry bits dropped during additions.
@@ -316,8 +315,8 @@ CalculateSum64 ( If Length is not aligned on a 64-bit boundary, then ASSERT().
If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
- @param Buffer Pointer to the buffer to carry out the checksum operation.
- @param Length The size, in bytes, of Buffer.
+ @param Buffer Pointer to the buffer to carry out the checksum operation.
+ @param Length The size, in bytes, of Buffer.
@return Checksum The 2's complement checksum of Buffer.
|