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

[mirror_edk2.git] / MdePkg / Library / DxeMemoryLib / MemLibInternals.h

diff --git a/MdePkg/Library/DxeMemoryLib/MemLibInternals.h b/MdePkg/Library/DxeMemoryLib/MemLibInternals.h
index 223cb25cf71700a5301b58c03775874de73a10f4..27c3c71851f36158c5f56e1b1459b1411b483442 100644 (file)
--- a/MdePkg/Library/DxeMemoryLib/MemLibInternals.h
+++ b/MdePkg/Library/DxeMemoryLib/MemLibInternals.h
@@ -10,12 +10,14 @@
   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 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 share the same version of this file:\r
+  The following BaseMemoryLib instances contain the same copy of this file:\r

 \r
     BaseMemoryLib\r
     BaseMemoryLibMmx\r
     BaseMemoryLibSse2\r
     BaseMemoryLibRepStr\r
 \r
     BaseMemoryLib\r
     BaseMemoryLibMmx\r
     BaseMemoryLibSse2\r
     BaseMemoryLibRepStr\r

+    BaseMemoryLibOptDxe\r
+    BaseMemoryLibOptPei\r

     PeiMemoryLib\r
     DxeMemoryLib\r
 \r
     PeiMemoryLib\r
     DxeMemoryLib\r
 \r


@@ -147,7 +149,9 @@ InternalMemZeroMem (
   @param  Length            Length of DestinationBuffer and SourceBuffer memory\r
                             regions to compare. Must be non-zero.\r
 \r
   @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
 \r
 **/\r
 INTN\r