Update the copyright notice format

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

diff --git a/MdePkg/Library/BaseMemoryLibOptDxe/MemLibInternals.h b/MdePkg/Library/BaseMemoryLibOptDxe/MemLibInternals.h
index ceddbbe7a05b30419497fa9c491fcbe03993c8b4..10c741f2c31138b6f810b0b25228487eb5e11423 100644 (file)
--- a/MdePkg/Library/BaseMemoryLibOptDxe/MemLibInternals.h
+++ b/MdePkg/Library/BaseMemoryLibOptDxe/MemLibInternals.h
@@ -1,16 +1,16 @@
 /** @file\r
   Declaration of internal functions for Base Memory Library.\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
     BaseMemoryLib\r
     BaseMemoryLibMmx\r
     BaseMemoryLibSse2\r
     BaseMemoryLibRepStr\r
-    PeiMemoryLib\r
-    DxeMemoryLib\r
+    BaseMemoryLibOptDxe\r
+    BaseMemoryLibOptPei\r
 \r
-  Copyright (c) 2006, Intel Corporation<BR>\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
+  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
   http://opensource.org/licenses/bsd-license.php\r
@@ -28,13 +28,12 @@
 #include <Library/BaseLib.h>\r
 #include <Library/DebugLib.h>\r
 \r
-\r
 /**\r
   Copy Length bytes from Source to Destination.\r
 \r
-  @param  Destination Target of copy\r
-  @param  Source Place to copy from\r
-  @param  Length Number of bytes to copy\r
+  @param  DestinationBuffer Target of copy\r
+  @param  SourceBuffer      Place to copy from\r
+  @param  Length            Number of bytes to copy\r
 \r
   @return Destination\r
 \r
@@ -50,9 +49,9 @@ InternalMemCopyMem (
 /**\r
   Set Buffer to Value for Size bytes.\r
 \r
-  @param  Buffer Memory to set.\r
-  @param  Size Number of bytes to set\r
-  @param  Value Value of the set operation.\r
+  @param  Buffer   Memory to set.\r
+  @param  Length   Number of bytes to set\r
+  @param  Value    Value of the set operation.\r
 \r
   @return Buffer\r
 \r
@@ -69,7 +68,7 @@ InternalMemSetMem (
   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
@@ -87,7 +86,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
@@ -105,7 +104,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
@@ -123,7 +122,7 @@ InternalMemSetMem64 (
   Set Buffer to 0 for Size bytes.\r
 \r
   @param  Buffer Memory to set.\r
-  @param  Size Number of bytes to set\r
+  @param  Length Number of bytes to set\r
 \r
   @return Buffer\r
 \r
@@ -143,7 +142,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
@@ -159,7 +160,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
@@ -178,7 +179,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
@@ -197,7 +198,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
@@ -216,7 +217,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