Fix function comment to follows doxygen format.

[mirror_edk2.git] / MdeModulePkg / Core / Pei / Reset / Reset.c

diff --git a/MdeModulePkg/Core/Pei/Reset/Reset.c b/MdeModulePkg/Core/Pei/Reset/Reset.c
index 4fcb59f3726a8f964ac37b4ee436cf10b304c16c..f71a23375f62a3f55985aca084bd1ddba68b7ce1 100644 (file)
--- a/MdeModulePkg/Core/Pei/Reset/Reset.c
+++ b/MdeModulePkg/Core/Pei/Reset/Reset.c
@@ -1,5 +1,6 @@
 /** @file\r
-\r
+  Pei Core Reset System Support\r
+  \r
 Copyright (c) 2006, 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
@@ -9,43 +10,27 @@ http://opensource.org/licenses/bsd-license.php
 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:\r
+**/\r
 \r
-  Reset.c\r
+#include <PeiMain.h>\r
 \r
-Abstract:\r
+/**\r
 \r
-  Pei Core Reset System Support\r
+  Core version of the Reset System\r
 \r
-Revision History\r
 \r
-**/\r
+  @param PeiServices     - The PEI core services table.\r
 \r
-#include <PeiMain.h>\r
+  @retval EFI_NOT_AVAILABLE_YET     PPI not available yet.\r
+  @retval EFI_DEVICE_ERROR          Did not reset system.\r
+                                    Otherwise, resets the system.\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PeiResetSystem (\r
   IN CONST EFI_PEI_SERVICES         **PeiServices\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Core version of the Reset System\r
-\r
-Arguments:\r
-\r
-  PeiServices - The PEI core services table.\r
-\r
-Returns:\r
-\r
-  Status  - EFI_NOT_AVAILABLE_YET. PPI not available yet.\r
-          - EFI_DEVICE_ERROR.   Did not reset system.\r
-          \r
-  Otherwise, resets the system. \r
-\r
---*/\r
 {\r
   EFI_STATUS        Status;\r
   EFI_PEI_RESET_PPI *ResetPpi;\r