Remove BugBug in comments and adjust function header according to code style doc.

[mirror_edk2.git] / MdePkg / Include / Protocol / SmmAccess.h

diff --git a/MdePkg/Include/Protocol/SmmAccess.h b/MdePkg/Include/Protocol/SmmAccess.h
index f405c8f13fdaa94d5a4546ec12b2c8162e2d68f8..3f177875398babeccfb5e5ee64c11f1f79205c23 100644 (file)
--- a/MdePkg/Include/Protocol/SmmAccess.h
+++ b/MdePkg/Include/Protocol/SmmAccess.h
@@ -46,16 +46,13 @@ typedef struct _EFI_SMM_ACCESS_PROTOCOL  EFI_SMM_ACCESS_PROTOCOL;
 /**\r
   Opens the SMRAM area to be accessible by a boot-service driver.\r
 \r
-  @param  This The EFI_SMM_ACCESS_PROTOCOL instance. \r
-  \r
-  @param  DescriptorIndex Indicates that the driver wishes to open \r
-  the memory tagged by this index. \r
+  @param  This                  The EFI_SMM_ACCESS_PROTOCOL instance.\r
+  @param  DescriptorIndex       Indicates that the driver wishes to open\r
+                                the memory tagged by this index.\r
 \r
-  @retval EFI_SUCCESS The operation was successful.\r
-  \r
+  @retval EFI_SUCCESS           The operation was successful.\r
   @retval EFI_INVALID_PARAMETER The given DescriptorIndex is not supported.\r
-  \r
-  @retval EFI_NOT_STARTED The SMM base service has not been initialized.\r
+  @retval EFI_NOT_STARTED       The SMM base service has not been initialized.\r
 \r
 **/\r
 typedef\r
@@ -68,18 +65,14 @@ EFI_STATUS
 /**\r
   Inhibits access to the SMRAM.\r
 \r
-  @param  This The EFI_SMM_ACCESS_PROTOCOL instance. \r
-  \r
-  @param  DescriptorIndex Indicates that the driver wishes to open \r
-  the memory tagged by this index. \r
+  @param  This                  The EFI_SMM_ACCESS_PROTOCOL instance.\r
+  @param  DescriptorIndex       Indicates that the driver wishes to open\r
+                                the memory tagged by this index.\r
 \r
-  @retval EFI_SUCCESS The operation was successful.\r
-  \r
-  @retval EFI_DEVICE_ERROR The given DescriptorIndex is not open.\r
-  \r
+  @retval EFI_SUCCESS           The operation was successful.\r
+  @retval EFI_DEVICE_ERROR      The given DescriptorIndex is not open.\r
   @retval EFI_INVALID_PARAMETER The given DescriptorIndex is not supported.\r
-  \r
-  @retval EFI_NOT_STARTED The SMM base service has not been initialized.\r
+  @retval EFI_NOT_STARTED       The SMM base service has not been initialized.\r
 \r
 **/\r
 typedef\r
@@ -91,19 +84,14 @@ EFI_STATUS
 \r
 /**\r
   Inhibits access to the SMRAM.\r
-  \r
-  @param  This The EFI_SMM_ACCESS_PROTOCOL instance. \r
-  \r
-  @param  DescriptorIndex Indicates that the driver wishes to open \r
-  the memory tagged by this index. \r
-\r
-  @retval EFI_SUCCESS The operation was successful.\r
-  \r
-  @retval EFI_DEVICE_ERROR The given DescriptorIndex is not open.\r
-  \r
+  @param  This                  The EFI_SMM_ACCESS_PROTOCOL instance.\r
+  @param  DescriptorIndex       Indicates that the driver wishes to open\r
+                                the memory tagged by this index.\r
+\r
+  @retval EFI_SUCCESS           The operation was successful.\r
+  @retval EFI_DEVICE_ERROR      The given DescriptorIndex is not open.\r
   @retval EFI_INVALID_PARAMETER The given DescriptorIndex is not supported.\r
-  \r
-  @retval EFI_NOT_STARTED The SMM base service has not been initialized.\r
+  @retval EFI_NOT_STARTED       The SMM base service has not been initialized.\r
 \r
 **/\r
 typedef\r
@@ -116,15 +104,12 @@ EFI_STATUS
 /**\r
   Queries the memory controller for the possible regions that will support SMRAM.\r
 \r
-  @param  This The EFI_SMM_ACCESS_PROTOCOL instance. \r
-  \r
-  @param  SmramMapSize A pointer to the size, in bytes, of the SmramMemoryMap buffer.\r
-  \r
-  @param  SmramMap A pointer to the buffer in which firmware places the current memory map.\r
+  @param  This                  The EFI_SMM_ACCESS_PROTOCOL instance.\r
+  @param  SmramMapSize          A pointer to the size, in bytes, of the SmramMemoryMap buffer.\r
+  @param  SmramMap              A pointer to the buffer in which firmware places the current memory map.\r
 \r
-  @retval EFI_SUCCESS The chipset supported the given resource.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The SmramMap parameter was too small.\r
+  @retval EFI_SUCCESS           The chipset supported the given resource.\r
+  @retval EFI_BUFFER_TOO_SMALL  The SmramMap parameter was too small.\r
 \r
 **/\r
 typedef\r