Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...

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

diff --git a/MdePkg/Include/Protocol/StatusCode.h b/MdePkg/Include/Protocol/StatusCode.h
index 2a2411ccf71c9767b8c7eb6ab44ff7cc19e73d0d..a0e81459aee46ca37db660219f2c8b6b8b44737f 100644 (file)
--- a/MdePkg/Include/Protocol/StatusCode.h
+++ b/MdePkg/Include/Protocol/StatusCode.h
@@ -1,15 +1,15 @@
 /** @file\r
-  Status code Runtime Protocol as defined in the DXE CIS\r
+  Status code Runtime Protocol as defined in PI Specification VOLUME 2 DXE\r
 \r
-  The StatusCode () Tiano service is added to the EFI system table and the \r
+  The StatusCode () service is added to the EFI system table and the \r
   EFI_STATUS_CODE_ARCH_PROTOCOL_GUID protocol is registered with a NULL \r
   pointer.\r
 \r
-  No CRC of the EFI system table is required, as it is done in the DXE core.\r
+  No CRC of the EFI system table is required, since that is done in the DXE core.\r
 \r
   This code abstracts Status Code reporting.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \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
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -18,17 +18,11 @@
   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
 \r
-  @par Revision Reference:\r
-  Version 0.91B.\r
-\r
 **/\r
 \r
 #ifndef __STATUS_CODE_RUNTIME_PROTOCOL_H__\r
 #define __STATUS_CODE_RUNTIME_PROTOCOL_H__\r
 \r
-#include <Pi/PiMultiPhase.h>\r
-#include <Uefi/UefiBaseType.h>\r
-\r
 #define EFI_STATUS_CODE_RUNTIME_PROTOCOL_GUID  \\r
 { 0xd2b2b828, 0x826, 0x48a7,  { 0xb3, 0xdf, 0x98, 0x3c, 0x0, 0x60, 0x24, 0xf0 } }\r
 \r
@@ -52,7 +46,7 @@
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_REPORT_STATUS_CODE) (\r
+(EFIAPI *EFI_REPORT_STATUS_CODE)(\r
   IN EFI_STATUS_CODE_TYPE     Type,\r
   IN EFI_STATUS_CODE_VALUE    Value,\r
   IN UINT32                   Instance,\r
@@ -60,14 +54,11 @@ EFI_STATUS
   IN EFI_STATUS_CODE_DATA     *Data      OPTIONAL\r
   );\r
 \r
-/**\r
-  Provides the service required to report a status code to the platform firmware.\r
-  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
-\r
-**/\r
+///\r
+/// Provides the service required to report a status code to the platform firmware.\r
+/// This protocol must be produced by a runtime DXE driver and may be consumed \r
+/// only by the DXE Foundation.\r
+///\r
 typedef struct _EFI_STATUS_CODE_PROTOCOL {\r
   EFI_REPORT_STATUS_CODE         ReportStatusCode;\r
 } EFI_STATUS_CODE_PROTOCOL;\r