Refine code for MdePkg/Include/Ppi according to code review comments.

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

diff --git a/MdePkg/Include/Ppi/Reset.h b/MdePkg/Include/Ppi/Reset.h
index 717f5df506fbe661d4942a20c7f2f00a9ce26b0f..b6d9beab50a3511fe30bdbd262328fa7af8e440c 100644 (file)
--- a/MdePkg/Include/Ppi/Reset.h
+++ b/MdePkg/Include/Ppi/Reset.h
@@ -29,15 +29,20 @@
     0xef398d58, 0x9dfd, 0x4103, {0xbf, 0x94, 0x78, 0xc6, 0xf4, 0xfe, 0x71, 0x2f } \\r
   }\r
 \r
-/**\r
-  @par Ppi Description:\r
-  This PPI provides provide a simple reset service. \r
-\r
-  @param ResetSystem\r
-  A service to reset the entire platform.\r
-\r
-**/\r
+//\r
+// EFI_PEI_RESET_PPI.ResetSystem() is equivalent to the\r
+// PEI Service ResetSystem().\r
+// It is defined in PiPeiCis.h. \r
+//\r
+\r
+///\r
+/// This PPI provides provide a simple reset service. \r
+///\r
 typedef struct {\r
+  ///\r
+  /// A service to reset the entire platform.\r
+  /// This function is defined in PiPeicis.h.\r
+  ///\r
   EFI_PEI_RESET_SYSTEM  ResetSystem;\r
 } EFI_PEI_RESET_PPI;\r
 \r