Correct Minor Comments in M3 to M4 review.

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

diff --git a/MdePkg/Include/Ppi/StatusCode.h b/MdePkg/Include/Ppi/StatusCode.h
index 5470222c5b6c94e05747702c9718727026db2081..c74cd835a77b20867a9902a1dbde4c6707575b9f 100644 (file)
--- a/MdePkg/Include/Ppi/StatusCode.h
+++ b/MdePkg/Include/Ppi/StatusCode.h
@@ -1,7 +1,8 @@
 /** @file\r
   This file declares Status Code PPI.\r
+  This ppi provides service that allows PEIMs to report status codes.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
@@ -10,29 +11,29 @@
   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
-  Module Name:  StatusCode.h\r
-\r
   @par Revision Reference:\r
-  This PPI is defined in PEI CIS.\r
-  Version 0.91.\r
+  This PPI is introduced in PI Version 1.0.\r
 \r
 **/\r
 \r
 #ifndef __STATUS_CODE_PPI_H__\r
 #define __STATUS_CODE_PPI_H__\r
 \r
+#include <Pi/PiPeiCis.h>\r
+\r
 #define EFI_PEI_REPORT_PROGRESS_CODE_PPI_GUID \\r
   { 0x229832d3, 0x7a30, 0x4b36, {0xb8, 0x27, 0xf4, 0xc, 0xb7, 0xd4, 0x54, 0x36 } }\r
 \r
-/**\r
-  @par Ppi Description:\r
-  This ppi provides the sevice to report status code. There can be only one instance \r
-  of this service in the system.\r
+//\r
+// EFI_PEI_PROGRESS_CODE_PPI.ReportStatusCode() is equivalent to the\r
+// PEI Service ReportStatusCode().\r
+// It is introduced in PIPeiCis.h. \r
+//\r
 \r
-  @param ReportStatusCode\r
-  Service that allows PEIMs to report status codes. This function is defined in Peicis.h\r
-\r
-**/\r
+///\r
+/// This PPI provides the sevice to report status code.\r
+/// There can be only one instance of this service in the system.\r
+///\r
 typedef struct {\r
   EFI_PEI_REPORT_STATUS_CODE  ReportStatusCode;\r
 } EFI_PEI_PROGRESS_CODE_PPI;\r