clean up baselib according to review comments.

[mirror_edk2.git] / MdePkg / Library / BaseLib / Ipf / Unaligned.c

diff --git a/MdePkg/Library/BaseLib/Ipf/Unaligned.c b/MdePkg/Library/BaseLib/Ipf/Unaligned.c
index ee6c94253ed72b3a9d8fbefc23881c643321fe2b..772d2f43efbbdc96e866e65075c0fec34aa568c0 100644 (file)
--- a/MdePkg/Library/BaseLib/Ipf/Unaligned.c
+++ b/MdePkg/Library/BaseLib/Ipf/Unaligned.c
@@ -1,7 +1,7 @@
 /** @file\r
   Unaligned access functions of BaseLib for IPF.\r
 \r
-  Copyright (c) 2006, Intel Corporation<BR>\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
@@ -12,7 +12,6 @@
 \r
 **/\r
 \r
-\r
 #include <BaseLibInternals.h>\r
 \r
 /**\r
@@ -25,13 +24,13 @@
 \r
   @param  Buffer  Pointer to a 16-bit value that may be unaligned.\r
 \r
-  @return *Uint16\r
+  @return The 16-bit value read from Buffer.\r
 \r
 **/\r
 UINT16\r
 EFIAPI\r
 ReadUnaligned16 (\r
-  IN      CONST UINT16              *Buffer\r
+  IN CONST UINT16              *Buffer\r
   )\r
 {\r
   ASSERT (Buffer != NULL);\r
@@ -51,14 +50,14 @@ ReadUnaligned16 (
   @param  Buffer  Pointer to a 16-bit value that may be unaligned.\r
   @param  Value   16-bit value to write to Buffer.\r
 \r
-  @return Value\r
+  @return The 16-bit value to write to Buffer.\r
 \r
 **/\r
 UINT16\r
 EFIAPI\r
 WriteUnaligned16 (\r
-  OUT     UINT16                    *Buffer,\r
-  IN      UINT16                    Value\r
+  OUT UINT16                    *Buffer,\r
+  IN  UINT16                    Value\r
   )\r
 {\r
   ASSERT (Buffer != NULL);\r
@@ -79,13 +78,13 @@ WriteUnaligned16 (
 \r
   @param  Buffer  Pointer to a 24-bit value that may be unaligned.\r
 \r
-  @return The value read.\r
+  @return The 24-bit value read from Buffer.\r
 \r
 **/\r
 UINT32\r
 EFIAPI\r
 ReadUnaligned24 (\r
-  IN      CONST UINT32              *Buffer\r
+  IN CONST UINT32              *Buffer\r
   )\r
 {\r
   ASSERT (Buffer != NULL);\r
@@ -108,14 +107,14 @@ ReadUnaligned24 (
   @param  Buffer  Pointer to a 24-bit value that may be unaligned.\r
   @param  Value   24-bit value to write to Buffer.\r
 \r
-  @return The value written.\r
+  @return The 24-bit value to write to Buffer.\r
 \r
 **/\r
 UINT32\r
 EFIAPI\r
 WriteUnaligned24 (\r
-  OUT     UINT32                    *Buffer,\r
-  IN      UINT32                    Value\r
+  OUT UINT32                    *Buffer,\r
+  IN  UINT32                    Value\r
   )\r
 {\r
   ASSERT (Buffer != NULL);\r
@@ -135,13 +134,13 @@ WriteUnaligned24 (
 \r
   @param  Buffer  Pointer to a 32-bit value that may be unaligned.\r
 \r
-  @return *Uint32\r
+  @return The 32-bit value read from Buffer.\r
 \r
 **/\r
 UINT32\r
 EFIAPI\r
 ReadUnaligned32 (\r
-  IN      CONST UINT32              *Buffer\r
+  IN CONST UINT32              *Buffer\r
   )\r
 {\r
   UINT16  LowerBytes;\r
@@ -167,14 +166,14 @@ ReadUnaligned32 (
   @param  Buffer  Pointer to a 32-bit value that may be unaligned.\r
   @param  Value   32-bit value to write to Buffer.\r
 \r
-  @return Value\r
+  @return The 32-bit value to write to Buffer.\r
 \r
 **/\r
 UINT32\r
 EFIAPI\r
 WriteUnaligned32 (\r
-  OUT     UINT32                    *Buffer,\r
-  IN      UINT32                    Value\r
+  OUT UINT32                    *Buffer,\r
+  IN  UINT32                    Value\r
   )\r
 {\r
   ASSERT (Buffer != NULL);\r
@@ -194,13 +193,13 @@ WriteUnaligned32 (
 \r
   @param  Buffer  Pointer to a 64-bit value that may be unaligned.\r
 \r
-  @return *Uint64\r
+  @return The 64-bit value read from Buffer.\r
 \r
 **/\r
 UINT64\r
 EFIAPI\r
 ReadUnaligned64 (\r
-  IN      CONST UINT64              *Buffer\r
+  IN CONST UINT64              *Buffer\r
   )\r
 {\r
   UINT32  LowerBytes;\r
@@ -226,14 +225,14 @@ ReadUnaligned64 (
   @param  Buffer  Pointer to a 64-bit value that may be unaligned.\r
   @param  Value   64-bit value to write to Buffer.\r
 \r
-  @return Value\r
+  @return The 64-bit value to write to Buffer.\r
 \r
 **/\r
 UINT64\r
 EFIAPI\r
 WriteUnaligned64 (\r
-  OUT     UINT64                    *Buffer,\r
-  IN      UINT64                    Value\r
+  OUT UINT64                    *Buffer,\r
+  IN  UINT64                    Value\r
   )\r
 {\r
   ASSERT (Buffer != NULL);\r