]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/BaseMemoryLibSse2/MemLibInternals.h
Minor grammatical work--mostly adding periods. Items with ONLY period added did...
[mirror_edk2.git] / MdePkg / Library / BaseMemoryLibSse2 / MemLibInternals.h
index 10c741f2c31138b6f810b0b25228487eb5e11423..c8e80aff0d6fac9bac7ed96109404fe8afe74053 100644 (file)
@@ -9,11 +9,11 @@
     BaseMemoryLibOptDxe\r
     BaseMemoryLibOptPei\r
 \r
-  Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2010, 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
+  http://opensource.org/licenses/bsd-license.php.\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
@@ -31,9 +31,9 @@
 /**\r
   Copy Length bytes from Source to Destination.\r
 \r
-  @param  DestinationBuffer Target of copy\r
-  @param  SourceBuffer      Place to copy from\r
-  @param  Length            Number of bytes to copy\r
+  @param  DestinationBuffer The target of the copy request.\r
+  @param  SourceBuffer      The place to copy from.\r
+  @param  Length            The number of bytes to copy.\r
 \r
   @return Destination\r
 \r
@@ -49,9 +49,9 @@ InternalMemCopyMem (
 /**\r
   Set Buffer to Value for Size bytes.\r
 \r
-  @param  Buffer   Memory to set.\r
-  @param  Length   Number of bytes to set\r
-  @param  Value    Value of the set operation.\r
+  @param  Buffer   The memory to set.\r
+  @param  Length   The number of bytes to set.\r
+  @param  Value    The value of the set operation.\r
 \r
   @return Buffer\r
 \r
@@ -67,9 +67,9 @@ InternalMemSetMem (
 /**\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  Count of 16-bit value to fill.\r
-  @param  Value   Value with which to fill Length bytes of Buffer.\r
+  @param  Buffer  The pointer to the target buffer to fill.\r
+  @param  Length  The count of 16-bit value to fill.\r
+  @param  Value   The value with which to fill Length bytes of Buffer.\r
 \r
   @return Buffer\r
 \r
@@ -85,9 +85,9 @@ InternalMemSetMem16 (
 /**\r
   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  Count of 32-bit value to fill.\r
-  @param  Value   Value with which to fill Length bytes of Buffer.\r
+  @param  Buffer  The pointer to the target buffer to fill.\r
+  @param  Length  The count of 32-bit value to fill.\r
+  @param  Value   The value with which to fill Length bytes of Buffer.\r
 \r
   @return Buffer\r
 \r
@@ -103,9 +103,9 @@ InternalMemSetMem32 (
 /**\r
   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  Count of 64-bit value to fill.\r
-  @param  Value   Value with which to fill Length bytes of Buffer.\r
+  @param  Buffer  The pointer to the target buffer to fill.\r
+  @param  Length  The count of 64-bit value to fill.\r
+  @param  Value   The value with which to fill Length bytes of Buffer.\r
 \r
   @return Buffer\r
 \r
@@ -122,7 +122,7 @@ InternalMemSetMem64 (
   Set Buffer to 0 for Size bytes.\r
 \r
   @param  Buffer Memory to set.\r
-  @param  Length Number of bytes to set\r
+  @param  Length The number of bytes to set\r
 \r
   @return Buffer\r
 \r
@@ -137,9 +137,9 @@ InternalMemZeroMem (
 /**\r
   Compares two memory buffers of a given length.\r
 \r
-  @param  DestinationBuffer First memory buffer\r
-  @param  SourceBuffer      Second memory buffer\r
-  @param  Length            Length of DestinationBuffer and SourceBuffer memory\r
+  @param  DestinationBuffer The first memory buffer.\r
+  @param  SourceBuffer      The second memory buffer.\r
+  @param  Length            The length of DestinationBuffer and SourceBuffer memory\r
                             regions to compare. Must be non-zero.\r
 \r
   @return 0                 All Length bytes of the two buffers are identical.\r
@@ -159,11 +159,11 @@ InternalMemCompareMem (
   Scans a target buffer for an 8-bit value, and returns a pointer to the\r
   matching 8-bit value in the target buffer.\r
 \r
-  @param  Buffer  Pointer to the target buffer to scan.\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
+  @param  Buffer  The pointer to the target buffer to scan.\r
+  @param  Length  The count of 8-bit value to scan. Must be non-zero.\r
+  @param  Value   The value to search for in the target buffer.\r
 \r
-  @return Pointer to the first occurrence or NULL if not found.\r
+  @return The pointer to the first occurrence or NULL if not found.\r
 \r
 **/\r
 CONST VOID *\r
@@ -178,11 +178,11 @@ InternalMemScanMem8 (
   Scans a target buffer for a 16-bit value, and returns a pointer to the\r
   matching 16-bit value in the target buffer.\r
 \r
-  @param  Buffer  Pointer to the target buffer to scan.\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
+  @param  Buffer  The pointer to the target buffer to scan.\r
+  @param  Length  The count of 16-bit value to scan. Must be non-zero.\r
+  @param  Value   The value to search for in the target buffer.\r
 \r
-  @return Pointer to the first occurrence or NULL if not found.\r
+  @return The pointer to the first occurrence or NULL if not found.\r
 \r
 **/\r
 CONST VOID *\r
@@ -197,11 +197,11 @@ InternalMemScanMem16 (
   Scans a target buffer for a 32-bit value, and returns a pointer to the\r
   matching 32-bit value in the target buffer.\r
 \r
-  @param  Buffer  Pointer to the target buffer to scan.\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
+  @param  Buffer  The pointer to the target buffer to scan.\r
+  @param  Length  The count of 32-bit value to scan. Must be non-zero.\r
+  @param  Value   The value to search for in the target buffer.\r
 \r
-  @return Pointer to the first occurrence or NULL if not found.\r
+  @return The pointer to the first occurrence or NULL if not found.\r
 \r
 **/\r
 CONST VOID *\r
@@ -216,11 +216,11 @@ InternalMemScanMem32 (
   Scans a target buffer for a 64-bit value, and returns a pointer to the\r
   matching 64-bit value in the target buffer.\r
 \r
-  @param  Buffer  Pointer to the target buffer to scan.\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
+  @param  Buffer  The pointer to the target buffer to scan.\r
+  @param  Length  The count of 64-bit value to scan. Must be non-zero.\r
+  @param  Value   The value to search for in the target buffer.\r
 \r
-  @return Pointer to the first occurrence or NULL if not found.\r
+  @return A pointer to the first occurrence or NULL if not found.\r
 \r
 **/\r
 CONST VOID *\r