Function description in baselib.h is not clear. change it to comply with Doxgen format.

[mirror_edk2.git] / MdePkg / Library / BaseLib / CheckSum.c

diff --git a/MdePkg/Library/BaseLib/CheckSum.c b/MdePkg/Library/BaseLib/CheckSum.c
index 8612c7c392bb574930d4f1a0456ef27fefd77731..78ff00c451004b22b42b215b7d8d6a36e0acaa00 100644 (file)
--- a/MdePkg/Library/BaseLib/CheckSum.c
+++ b/MdePkg/Library/BaseLib/CheckSum.c
@@ -31,8 +31,8 @@
   If Buffer is NULL, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the sum operation.\r
-  @param  Length           The size, in bytes, of Buffer .\r
+  @param  Buffer      Pointer to the buffer to carry out the sum operation.\r
+  @param  Length      The size, in bytes, of Buffer .\r
 \r
   @return Sum         The sum of Buffer with carry bits dropped during additions.\r
 \r
@@ -70,9 +70,8 @@ CalculateSum8 (
   If Buffer is NULL, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-\r
-  @param  Buffer                       Pointer to the buffer to carry out the checksum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the checksum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Checksum       The 2's complement checksum of Buffer.\r
 \r
@@ -107,8 +106,8 @@ CalculateCheckSum8 (
   If Length is not aligned on a 16-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the sum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the sum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Sum         The sum of Buffer with carry bits dropped during additions.\r
 \r
@@ -152,8 +151,8 @@ CalculateSum16 (
   If Length is not aligned on a 16-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the checksum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the checksum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Checksum       The 2's complement checksum of Buffer.\r
 \r
@@ -189,8 +188,8 @@ CalculateCheckSum16 (
   If Length is not aligned on a 32-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the sum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the sum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Sum         The sum of Buffer with carry bits dropped during additions.\r
 \r
@@ -234,8 +233,8 @@ CalculateSum32 (
   If Length is not aligned on a 32-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the checksum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the checksum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Checksum       The 2's complement checksum of Buffer.\r
 \r
@@ -271,8 +270,8 @@ CalculateCheckSum32 (
   If Length is not aligned on a 64-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the sum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the sum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Sum         The sum of Buffer with carry bits dropped during additions.\r
 \r
@@ -316,8 +315,8 @@ CalculateSum64 (
   If Length is not aligned on a 64-bit boundary, then ASSERT().\r
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
 \r
-  @param  Buffer                       Pointer to the buffer to carry out the checksum operation.\r
-  @param  Length           The size, in bytes, of Buffer.\r
+  @param  Buffer      Pointer to the buffer to carry out the checksum operation.\r
+  @param  Length      The size, in bytes, of Buffer.\r
 \r
   @return Checksum       The 2's complement checksum of Buffer.\r
 \r