Formalize comments for Protocols and PPIs.

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

diff --git a/MdePkg/Include/Ppi/StatusCode.h b/MdePkg/Include/Ppi/StatusCode.h
index 1283e5ee121ebb71a56d8a7fbb8af55593bba1fe..537059bc4a58797b34f6f83d97330e6acc904758 100644 (file)
--- a/MdePkg/Include/Ppi/StatusCode.h
+++ b/MdePkg/Include/Ppi/StatusCode.h
@@ -25,15 +25,16 @@
 #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
-  @param ReportStatusCode\r
-  Service that allows PEIMs to report status codes. This function is defined in PiPeicis.h\r
-\r
-**/\r
+//\r
+// EFI_PEI_PROGRESS_CODE_PPI.ReportStatusCode() is equivalent to the\r
+// PEI Service ReportStatusCode().\r
+// It is defined in PiPeiCis.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