CodeReview for MdePkg/BaseMemoryXXX libraries. Refine file description, function...

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

diff --git a/MdePkg/Library/BaseMemoryLib/MemLibGeneric.c b/MdePkg/Library/BaseMemoryLib/MemLibGeneric.c
index 356700f96efb841d4e7ed7240cacea4540fa837e..84ca4d9a8b512f3261dd4686288f211faa4c5e27 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
+    DxeMemoryLib\r
+\r
+  Copyright (c) 2006 - 2008, 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,12 +15,6 @@
   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
@@ -122,7 +121,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