clean up all of eight BaseMemoryLib instances in MdePkg with the following updates:

[mirror_edk2.git] / MdePkg / Library / BaseMemoryLib / MemLibGeneric.c

diff --git a/MdePkg/Library/BaseMemoryLib/MemLibGeneric.c b/MdePkg/Library/BaseMemoryLib/MemLibGeneric.c
index 356700f96efb841d4e7ed7240cacea4540fa837e..e9e0f171ba0e9188ee2aee2069939c8a20716fe9 100644 (file)
--- a/MdePkg/Library/BaseMemoryLib/MemLibGeneric.c
+++ b/MdePkg/Library/BaseMemoryLib/MemLibGeneric.c
@@ -1,7 +1,12 @@
 /** @file\r
   Architecture Independent Base Memory Library Implementation.\r
 \r
-  Copyright (c) 2006, Intel Corporation<BR>\r
+  The following BaseMemoryLib instances contain the same copy of this file:\r
+    BaseMemoryLib\r
+    PeiMemoryLib\r
+    UefiMemoryLib\r
+\r
+  Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
   All rights reserved. This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -10,24 +15,15 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-  The following BaseMemoryLib instances contain the same copy of this file:\r
-\r
-    BaseMemoryLib\r
-    PeiMemoryLib\r
-    DxeMemoryLib\r
-\r
 **/\r
 \r
-\r
-\r
-\r
 #include "MemLibInternals.h"\r
 \r
 /**\r
   Fills a target buffer with a 16-bit value, and returns the target buffer.\r
 \r
   @param  Buffer  Pointer to the target buffer to fill.\r
-  @param  Length  Number of bytes in Buffer to fill.\r
+  @param  Length  Count of 16-bit value to fill.\r
   @param  Value   Value with which to fill Length bytes of Buffer.\r
 \r
   @return Buffer\r
@@ -51,7 +47,7 @@ InternalMemSetMem16 (
   Fills a target buffer with a 32-bit value, and returns the target buffer.\r
 \r
   @param  Buffer  Pointer to the target buffer to fill.\r
-  @param  Length  Number of bytes in Buffer to fill.\r
+  @param  Length  Count of 32-bit value to fill.\r
   @param  Value   Value with which to fill Length bytes of Buffer.\r
 \r
   @return Buffer\r
@@ -75,7 +71,7 @@ InternalMemSetMem32 (
   Fills a target buffer with a 64-bit value, and returns the target buffer.\r
 \r
   @param  Buffer  Pointer to the target buffer to fill.\r
-  @param  Length  Number of bytes in Buffer to fill.\r
+  @param  Length  Count of 64-bit value to fill.\r
   @param  Value   Value with which to fill Length bytes of Buffer.\r
 \r
   @return Buffer\r
@@ -122,7 +118,9 @@ InternalMemZeroMem (
   @param  Length            Length of DestinationBuffer and SourceBuffer memory\r
                             regions to compare. Must be non-zero.\r
 \r
-  @retval 0     if MemOne == MemTwo\r
+  @return 0                 All Length bytes of the two buffers are identical.\r
+  @retval Non-zero          The first mismatched byte in SourceBuffer subtracted from the first\r
+                            mismatched byte in DestinationBuffer.\r
 \r
 **/\r
 INTN\r
@@ -146,7 +144,7 @@ InternalMemCompareMem (
   matching 8-bit value in the target buffer.\r
 \r
   @param  Buffer  Pointer to the target buffer to scan.\r
-  @param  Length  Number of bytes in Buffer to scan. Must be non-zero.\r
+  @param  Length  Count of 8-bit value to scan. Must be non-zero.\r
   @param  Value   Value to search for in the target buffer.\r
 \r
   @return Pointer to the first occurrence or NULL if not found.\r
@@ -176,7 +174,7 @@ InternalMemScanMem8 (
   matching 16-bit value in the target buffer.\r
 \r
   @param  Buffer  Pointer to the target buffer to scan.\r
-  @param  Length  Number of bytes in Buffer to scan. Must be non-zero.\r
+  @param  Length  Count of 16-bit value to scan. Must be non-zero.\r
   @param  Value   Value to search for in the target buffer.\r
 \r
   @return Pointer to the first occurrence or NULL if not found.\r
@@ -206,7 +204,7 @@ InternalMemScanMem16 (
   matching 32-bit value in the target buffer.\r
 \r
   @param  Buffer  Pointer to the target buffer to scan.\r
-  @param  Length  Number of bytes in Buffer to scan. Must be non-zero.\r
+  @param  Length  Count of 32-bit value to scan. Must be non-zero.\r
   @param  Value   Value to search for in the target buffer.\r
 \r
   @return Pointer to the first occurrence or NULL if not found.\r
@@ -236,7 +234,7 @@ InternalMemScanMem32 (
   matching 64-bit value in the target buffer.\r
 \r
   @param  Buffer  Pointer to the target buffer to scan.\r
-  @param  Length  Number of bytes in Buffer to scan. Must be non-zero.\r
+  @param  Length  Count of 64-bit value to scan. Must be non-zero.\r
   @param  Value   Value to search for in the target buffer.\r
 \r
   @return Pointer to the first occurrence or NULL if not found.\r