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

[mirror_edk2.git] / MdePkg / Include / Dxe / ArchProtocol / StatusCode.h

diff --git a/MdePkg/Include/Dxe/ArchProtocol/StatusCode.h b/MdePkg/Include/Dxe/ArchProtocol/StatusCode.h
index 6440dc338864d4245085d6d92a81c9cdbb03b23f..6bfaeaedd27c81b7dd6d0ea6e5d39fc6bad62b63 100644 (file)
--- a/MdePkg/Include/Dxe/ArchProtocol/StatusCode.h
+++ b/MdePkg/Include/Dxe/ArchProtocol/StatusCode.h
@@ -34,24 +34,19 @@
 /**\r
   Provides an interface that a software module can call to report a status code.\r
 \r
-  @param  Type Indicates the type of status code being reported.\r
-  \r
-  @param  Value Describes the current status of a hardware or software entity.\r
-  This included information about the class and subclass that is used to \r
-  classify the entity as well as an operation.\r
-  \r
-  @param  Instance The enumeration of a hardware or software entity within \r
-  the system. Valid instance numbers start with 1.\r
-  \r
-  @param  CallerId This optional parameter may be used to identify the caller.\r
-  This parameter allows the status code driver to apply different rules to \r
-  different callers.\r
-  \r
-  @param  Data This optional parameter may be used to pass additional data.\r
-\r
-  @retval EFI_SUCCESS The function completed successfully\r
-  \r
-  @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.\r
+  @param  Type             Indicates the type of status code being reported.\r
+  @param  Value            Describes the current status of a hardware or software entity.\r
+                           This included information about the class and subclass that is used to\r
+                           classify the entity as well as an operation.\r
+  @param  Instance         The enumeration of a hardware or software entity within\r
+                           the system. Valid instance numbers start with 1.\r
+  @param  CallerId         This optional parameter may be used to identify the caller.\r
+                           This parameter allows the status code driver to apply different rules to\r
+                           different callers.\r
+  @param  Data             This optional parameter may be used to pass additional data.\r
+\r
+  @retval EFI_SUCCESS           The function completed successfully\r
+  @retval EFI_DEVICE_ERROR      The function should not be completed due to a device error.\r
 \r
 **/\r
 typedef\r
@@ -70,7 +65,7 @@ EFI_STATUS
   This protocol must be produced by a runtime DXE driver and may be consumed \r
   only by the DXE Foundation.\r
 \r
-  @param ReportStatusCode Emit a status code.\r
+  @param  ReportStatusCode Emit a status code.\r
 \r
 **/\r
 typedef struct _EFI_STATUS_CODE_PROTOCOL {\r