Update some comments for MdeModulePkg Include header files.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8536 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h b/MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h
index aab340b55daeb729a5f632002413d54dfd0a3169..f608ae4ae970b5fc99320780ffe7a3119eca06e1 100644 (file)
--- a/MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h
+++ b/MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h
@@ -1,10 +1,7 @@
 /** @file\r
-\r
-  This file defines a group of guids to specify the different \r
+  This file defines CRC32 GUID to specify the CRC32 \r
   encapsulation scheme for the GUIDed section.\r
 \r
-  Only one GUID is defined for the CRC32 encapsulation scheme.\r
-\r
   Copyright (c) 2006 - 2009, Intel Corporation\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
@@ -19,10 +16,6 @@
 #ifndef __CRC32_GUIDED_SECTION_EXTRACTION_H__\r
 #define __CRC32_GUIDED_SECTION_EXTRACTION_H__\r
 \r
-//\r
-// GUID definition. All GUIDed section extraction protocols share the\r
-// same interface, but each has a different GUID. All the GUIDs are defined here.\r
-//\r
 #define EFI_CRC32_GUIDED_SECTION_EXTRACTION_GUID \\r
   { 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } }\r
 \r

diff --git a/MdeModulePkg/Include/Guid/MemoryTypeInformation.h b/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
index f2c0ae3fcdc298d81f01a1b21dca867c1b1ef34c..6143dc70dd54ce9a70573599cb1cb430704e34b5 100644 (file)
--- a/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
+++ b/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
@@ -1,9 +1,13 @@
 /** @file\r
-  This file defines the memory type information GUID for its variable and guid. \r
-  It also defines memory type info variable name and data structure for both variable and hob,\r
-  which can be used to store the information for each memory type in EFI variable or HOB.\r
+  This file defines:\r
+  * Memory Type Information GUID for HOB and Variable\r
+  * Memory Type Information Variable Name\r
+  * Memory Type Information GUID HOB data structure\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
+  The memory type information HOB and variable can \r
+  be used to store the information for each memory type in Variable or HOB.\r
+\r
+Copyright (c) 2006 - 2009, 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

diff --git a/MdeModulePkg/Include/Library/HiiLib.h b/MdeModulePkg/Include/Library/HiiLib.h
index af3ed0eb2b4bb64aa61f23a514b78dc2b3b65c33..dd8c231d4fbbd20a1423f35437d41d58def18e48 100644 (file)
--- a/MdeModulePkg/Include/Library/HiiLib.h
+++ b/MdeModulePkg/Include/Library/HiiLib.h
@@ -304,8 +304,8 @@ HiiConstructConfigHdr (
 BOOLEAN\r
 EFIAPI                               \r
 HiiSetToDefaults (     \r
-  IN CONST EFI_STRING  Request,  OPTIONAL\r
-  IN UINT16                                DefaultId\r
+  IN CONST EFI_STRING  Request,  OPTIONAL\r
+  IN UINT16            DefaultId\r
   );\r
 \r
 /**\r
@@ -325,7 +325,7 @@ HiiSetToDefaults (
 BOOLEAN\r
 EFIAPI                               \r
 HiiValidateSettings (\r
-  IN CONST EFI_STRING  Request  OPTIONAL\r
+  IN CONST EFI_STRING  Request  OPTIONAL\r
   );\r
 \r
 /**\r

diff --git a/MdeModulePkg/Include/Library/ResetSystemLib.h b/MdeModulePkg/Include/Library/ResetSystemLib.h
index f77c441ad57bdd8670f833c1211739aaecb88726..4b67865fa385498f5db0b82b8ed1da94a90c294f 100644 (file)
--- a/MdeModulePkg/Include/Library/ResetSystemLib.h
+++ b/MdeModulePkg/Include/Library/ResetSystemLib.h
@@ -46,8 +46,7 @@ ResetWarm (
   This function causes the system to enter a power state equivalent \r
   to the ACPI G2/S5 or G3 states.\r
   \r
-  If this function returns, it means the system does \r
-  not support shut down reset.\r
+  If this function returns, it means that the system does not support shut down reset.\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -56,11 +55,9 @@ ResetShutdown (
   );\r
 \r
 /**\r
-  This function causes the system to enter S3 and then\r
-  wake up immediately.\r
+  This function causes the system to enter S3 and then wake up immediately.\r
   \r
-  If this function returns, it means the\r
-  system does not support the feature.\r
+  If this function returns, it means that the system does not support S3 feature.\r
 **/\r
 VOID\r
 EFIAPI\r

diff --git a/MdeModulePkg/Include/Protocol/GenericMemoryTest.h b/MdeModulePkg/Include/Protocol/GenericMemoryTest.h
index 1abaf88fdaabdf85f36f77b3b07c0426483fdfa9..ad628a0e5dd9dcc555ec5d624c2b05da901fb182 100644 (file)
--- a/MdeModulePkg/Include/Protocol/GenericMemoryTest.h
+++ b/MdeModulePkg/Include/Protocol/GenericMemoryTest.h
@@ -1,7 +1,7 @@
 /** @file\r
   This protocol defines the generic memory test interfaces in Dxe phase.\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
+Copyright (c) 2006 - 2009, 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
@@ -59,7 +59,7 @@ EFI_STATUS
   @param  This                Protocol instance pointer. \r
   @param  TestedMemorySize    Return the tested extended memory size. \r
   @param  TotalMemorySize     Return the whole system physical memory size. \r
-                                                                                                               The total memory size does not include memory in a slot with a disabled DIMM.  \r
+                              The total memory size does not include memory in a slot with a disabled DIMM.  \r
   @param  ErrorOut            TRUE if the memory error occured.\r
   @param  IfTestAbort         Indicates that the user pressed "ESC" to skip the memory test. \r
 \r
@@ -94,8 +94,7 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Provides the capability to test the compatible range used by a special\r
-  driver.\r
+  Provides the capability to test the compatible range used by some special drivers.\r
 \r
   @param  This                Protocol instance pointer. \r
   @param  StartAddress        The start address of the compatible memory range that\r

diff --git a/MdeModulePkg/Include/Protocol/Print2.h b/MdeModulePkg/Include/Protocol/Print2.h
index de590e89aa36f30a682a2199f4544bb6f0348033..848b2b14dfd0ed117d1a4cb4358db78f09165e2c 100644 (file)
--- a/MdeModulePkg/Include/Protocol/Print2.h
+++ b/MdeModulePkg/Include/Protocol/Print2.h
@@ -29,13 +29,13 @@ typedef struct _EFI_PRINT2_PROTOCOL  EFI_PRINT2_PROTOCOL;
   Produces a Null-terminated Unicode string in an output buffer, based on \r
   a Null-terminated Unicode format string and a BASE_LIST argument list\r
   \r
-  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
-  and BufferSize.  \r
+  Produces a Null-terminated Unicode string in the output buffer \r
+  specified by StartOfBuffer and BufferSize.  \r
   The Unicode string is produced by parsing the format string specified by FormatString.  \r
-  Arguments are pulled from the variable argument list specified by Marker. Marker is constructed based on the \r
-  contents of the format string.  \r
-  This function returns the number of Unicode characters in the produced output buffer, not including\r
-  the Null-terminator.\r
+  Arguments are pulled from the variable argument list specified by Marker.\r
+  Marker is constructed based on the contents of the format string.  \r
+  This function returns the number of Unicode characters in the produced output buffer, \r
+  not including the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
@@ -43,8 +43,7 @@ typedef struct _EFI_PRINT2_PROTOCOL  EFI_PRINT2_PROTOCOL;
   If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
   If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
-  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
-  ASSERT().\r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
   contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
   Null-terminator, then ASSERT().\r
@@ -72,12 +71,12 @@ UINTN
   Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated \r
   Unicode format string and variable argument list.\r
   \r
-  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
-  and BufferSize.\r
+  Produces a Null-terminated Unicode string in the output buffer \r
+  specified by StartOfBuffer and BufferSize.\r
   The Unicode string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list based on the contents of the format string.\r
-  This function returns the number of Unicode characters in the produced output buffer, not including\r
-  the Null-terminator.\r
+  This function returns the number of Unicode characters in the produced output buffer, \r
+  not including the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
@@ -85,8 +84,7 @@ UINTN
   If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
   If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
-  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
-  ASSERT().\r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
   contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
   Null-terminator, then ASSERT().\r
@@ -115,21 +113,20 @@ UINTN
   Produces a Null-terminated Unicode string in an output buffer, based on a Null-terminated\r
   ASCII format string and a BASE_LIST argument list\r
   \r
-  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
-  and BufferSize.\r
+  Produces a Null-terminated Unicode string in the output buffer \r
+  specified by StartOfBuffer and BufferSize.\r
   The Unicode string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list specified by Marker based on the \r
   contents of the format string.\r
-  This function returns the number of Unicode characters in the produced output buffer, not including\r
-  the Null-terminator.\r
+  This function returns the number of Unicode characters in the produced output buffer, \r
+  not including the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
   If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
   If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
-  ASSERT().\r
+  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
   contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
   Null-terminator, then ASSERT().\r
@@ -157,21 +154,19 @@ UINTN
   Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated \r
   ASCII format string and a variable argument list.\r
   \r
-  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
-  and BufferSize.\r
+  Produces a Null-terminated Unicode string in the output buffer \r
+  specified by StartOfBuffer and BufferSize.\r
   The Unicode string is produced by parsing the format string specified by FormatString.\r
-  Arguments are pulled from the variable argument list based on the contents of the \r
-  format string.\r
-  This function returns the number of Unicode characters in the produced output buffer, not including\r
-  the Null-terminator.\r
+  Arguments are pulled from the variable argument list based on the contents of the format string.\r
+  This function returns the number of Unicode characters in the produced output buffer, \r
+  not including the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
   If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
   If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
-  ASSERT().\r
+  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
   contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
   Null-terminator, then ASSERT().\r
@@ -250,20 +245,19 @@ UINTN
   Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
   ASCII format string and a BASE_LIST argument list.\r
   \r
-  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
-  and BufferSize.\r
+  Produces a Null-terminated ASCII string in the output buffer \r
+  pecified by StartOfBuffer and BufferSize.\r
   The ASCII string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list specified by Marker based on \r
   the contents of the format string.\r
-  This function returns the number of ASCII characters in the output buffer, not including\r
-  the Null-terminator.\r
+  This function returns the number of ASCII characters in the output buffer, \r
+  not including the Null-terminator.\r
   If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
   If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
-  ASSERT().\r
+  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
   contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
   Null-terminator, then ASSERT().\r
@@ -291,20 +285,18 @@ UINTN
   Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
   ASCII format string and variable argument list.\r
   \r
-  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
-  and BufferSize.\r
+  Produces a Null-terminated ASCII string in the output buffer \r
+  specified by StartOfBuffer and BufferSize.\r
   The ASCII string is produced by parsing the format string specified by FormatString.\r
-  Arguments are pulled from the variable argument list based on the contents of the \r
-  format string.\r
-  This function returns the number of ASCII characters in the output buffer, not including\r
-  the Null-terminator.\r
+  Arguments are pulled from the variable argument list based on the contents of the format string.\r
+  This function returns the number of ASCII characters in the output buffer, \r
+  not including the Null-terminator.\r
   If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
   If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
-  ASSERT().\r
+  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
   contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
   Null-terminator, then ASSERT().\r
@@ -333,21 +325,20 @@ UINTN
   Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
   Unicode format string and a BASE_LIST argument list.\r
   \r
-  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
-  and BufferSize.\r
+  Produces a Null-terminated ASCII string in the output buffer \r
+  specified by StartOfBuffer and BufferSize.\r
   The ASCII string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list specified by Marker based on \r
   the contents of the format string.\r
-  This function returns the number of ASCII characters in the output buffer, not including\r
-  the Null-terminator.\r
+  This function returns the number of ASCII characters in the output buffer, \r
+  not including the Null-terminator.\r
   If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
   If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
   If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
-  ASSERT().\r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
   contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
   Null-terminator, then ASSERT().\r
@@ -375,21 +366,19 @@ UINTN
   Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
   Unicode format string and  variable argument list.\r
   \r
-  Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
-  and BufferSize.\r
+  Produces a Null-terminated ASCII string in the output buffer \r
+  specified by StartOfBuffer and BufferSize.\r
   The ASCII string is produced by parsing the format string specified by FormatString.\r
-  Arguments are pulled from the variable argument list based on the contents of the \r
-  format string.\r
-  This function returns the number of ASCII characters in the output buffer, not including\r
-  the Null-terminator.\r
+  Arguments are pulled from the variable argument list based on the contents of the format string.\r
+  This function returns the number of ASCII characters in the output buffer, \r
+  not including the Null-terminator.\r
   If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
   If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
   If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
-  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
-  ASSERT().\r
+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
   contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
   Null-terminator, then ASSERT().\r
@@ -418,8 +407,7 @@ UINTN
   Converts a decimal value to a Null-terminated ASCII string.\r
   \r
   Converts the decimal number specified by Value to a Null-terminated ASCII string \r
-  specified by Buffer containing at most Width characters. No padding of spaces \r
-  is ever performed.\r
+  specified by Buffer containing at most Width characters. No padding of spaces is ever performed.\r
   If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
   The number of ASCII characters in Buffer is returned not including the Null-terminator.\r
   If the conversion contains more than Width characters, then only the first Width\r

diff --git a/MdeModulePkg/Include/Protocol/SwapAddressRange.h b/MdeModulePkg/Include/Protocol/SwapAddressRange.h
index b6898be8d02500852ec702437e1eb82ea55728cc..4018ba49b6d269d8eef0136693fb552605e4bbac 100644 (file)
--- a/MdeModulePkg/Include/Protocol/SwapAddressRange.h
+++ b/MdeModulePkg/Include/Protocol/SwapAddressRange.h
@@ -43,39 +43,39 @@ typedef UINT8 EFI_SWAP_LOCK_CAPABILITY;
   This function gets the address range location of \r
   boot block and backup block. \r
 \r
-  @param This                    Indicates the calling context.  \r
-  @param BootBlockBase         Base address of current boot block.\r
-  @param BootBlockSize         Size (in bytes) of current boot block.\r
-  @param BackupBlockBase       Base address of current backup block.\r
-  @param BackupBlockSize       Size (in bytes) of current backup block.\r
+  @param This             Indicates the calling context.  \r
+  @param BootBlockBase    Base address of current boot block.\r
+  @param BootBlockSize    Size (in bytes) of current boot block.\r
+  @param BackupBlockBase  Base address of current backup block.\r
+  @param BackupBlockSize  Size (in bytes) of current backup block.\r
 \r
-  @retval EFI_SUCCESS  The call was successful.\r
+  @retval EFI_SUCCESS  The call was successful.\r
     \r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_GET_RANGE_LOCATION) (\r
-  IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL            * This,\r
-  OUT EFI_PHYSICAL_ADDRESS                      * BootBlockBase,\r
+  IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL            *This,\r
+  OUT EFI_PHYSICAL_ADDRESS                      *BootBlockBase,\r
   OUT UINTN                                     *BootBlockSize,\r
-  OUT EFI_PHYSICAL_ADDRESS                      * BackupBlockBase,\r
+  OUT EFI_PHYSICAL_ADDRESS                      *BackupBlockBase,\r
   OUT UINTN                                     *BackupBlockSize\r
   );\r
 \r
 /**\r
   This service checks if the boot block and backup block has been swapped.\r
 \r
-  @param This                Indicates the calling context.  \r
-  @param SwapState             True if the boot block and backup block has been swapped. \r
-                      False if the boot block and backup block has not been swapped.\r
+  @param This          Indicates the calling context.  \r
+  @param SwapState     True if the boot block and backup block has been swapped. \r
+                       False if the boot block and backup block has not been swapped.\r
 \r
-  @retval EFI_SUCCESS  The call was successful.\r
+  @retval EFI_SUCCESS  The call was successful.\r
     \r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_GET_SWAP_STATE) (\r
-  IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL            * This,\r
+  IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL            *This,\r
   OUT BOOLEAN                                   *SwapState\r
   );\r
 \r
@@ -85,17 +85,17 @@ EFI_STATUS
   It also acquires and releases software swap lock during operation. The setting of the new swap state \r
   is not affected by the old swap state.\r
 \r
-  @param This                  Indicates the calling context.  \r
-  @param NewSwapState          True to swap real boot block and backup block, False to swap them back.\r
+  @param This            Indicates the calling context.  \r
+  @param NewSwapState    True to swap real boot block and backup block, False to swap them back.\r
 \r
-  @retval EFI_SUCCESS  The call was successful.\r
-  @retval EFI_ABORTED  Set swap state error\r
+  @retval EFI_SUCCESS  The call was successful.\r
+  @retval EFI_ABORTED  Set swap state error\r
     \r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_SET_SWAP_STATE) (\r
-  IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL            * This,\r
+  IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL            *This,\r
   IN BOOLEAN                                    NewSwapState\r
   );\r
 \r
@@ -116,16 +116,16 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_GET_RTC_POWER_STATUS) (\r
-  IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL            * This,\r
+  IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL            *This,\r
   OUT BOOLEAN                                   *RtcPowerFailed\r
   );\r
 \r
 /**\r
   This service returns all lock methods for swap operations that the current platform supports. Could be software lock, hardware lock, or unsupport lock.\r
-       Note that software and hardware lock methods can be used simultaneously.\r
+  Note that software and hardware lock methods can be used simultaneously.\r
 \r
   @param This             Indicates the calling context.\r
-  @param LockCapability                Current lock method for swap operation. \r
+  @param LockCapability   Current lock method for swap operation. \r
 \r
   @retval EFI_SUCCESS The call was successful.\r
     \r
@@ -133,8 +133,8 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_GET_SWAP_LOCK_CAPABILITY) (\r
-  IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL            * This,\r
-  OUT EFI_SWAP_LOCK_CAPABILITY                  * LockCapability\r
+  IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL            *This,\r
+  OUT EFI_SWAP_LOCK_CAPABILITY                  *LockCapability\r
   );\r
 \r
 \r
@@ -154,7 +154,7 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_SET_SWAP_LOCK) (\r
-  IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL            * This,\r
+  IN EFI_SWAP_ADDRESS_RANGE_PROTOCOL            *This,\r
   IN EFI_SWAP_LOCK_CAPABILITY                   LockCapability,\r
   IN BOOLEAN                                    NewLockState\r
   );\r