Fix function comment to follows doxygen format.

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

diff --git a/MdeModulePkg/Core/Pei/StatusCode/StatusCode.c b/MdeModulePkg/Core/Pei/StatusCode/StatusCode.c
index b9316b6e9e1141fd53e1ccf42958078b692c0244..8e271d5e633848e736d879f23a81ecd3449e01af 100644 (file)
--- a/MdeModulePkg/Core/Pei/StatusCode/StatusCode.c
+++ b/MdeModulePkg/Core/Pei/StatusCode/StatusCode.c
@@ -1,5 +1,6 @@
-/*++\r
-\r
+/** @file\r
+  Pei Core Status Code 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,56 +10,36 @@ 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
-  StatusCode.c\r
+#include <PeiMain.h>\r
 \r
-Abstract:\r
+/**\r
 \r
-  Pei Core Status Code Support\r
+  Core version of the Status Code reporter\r
 \r
-Revision History\r
 \r
---*/\r
+  @param PeiServices     The PEI core services table.\r
+  @param CodeType        Type of Status Code.\r
+  @param Value           Value to output for Status Code.\r
+  @param Instance        Instance Number of this status code.\r
+  @param CallerId        ID of the caller of this status code.\r
+  @param Data            Optional data associated with this status code.\r
 \r
-#include <PeiMain.h>\r
+  @retval EFI_SUCCESS             if status code is successfully reported\r
+  @retval EFI_NOT_AVAILABLE_YET   if StatusCodePpi has not been installed\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PeiReportStatusCode (\r
-  IN EFI_PEI_SERVICES         **PeiServices,\r
-  IN EFI_STATUS_CODE_TYPE     CodeType,\r
-  IN EFI_STATUS_CODE_VALUE    Value, \r
-  IN UINT32                   Instance,\r
-  IN EFI_GUID                 *CallerId,\r
-  IN EFI_STATUS_CODE_DATA     *Data OPTIONAL\r
+  IN CONST EFI_PEI_SERVICES         **PeiServices,\r
+  IN EFI_STATUS_CODE_TYPE           CodeType,\r
+  IN EFI_STATUS_CODE_VALUE          Value, \r
+  IN UINT32                         Instance,\r
+  IN CONST EFI_GUID                 *CallerId,\r
+  IN CONST EFI_STATUS_CODE_DATA     *Data OPTIONAL\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Core version of the Status Code reporter\r
-\r
-Arguments:\r
-\r
-  PeiServices - The PEI core services table.\r
-  \r
-  CodeType    - Type of Status Code.\r
-  \r
-  Value       - Value to output for Status Code.\r
-  \r
-  Instance    - Instance Number of this status code.\r
-  \r
-  CallerId    - ID of the caller of this status code.\r
-  \r
-  Data        - Optional data associated with this status code.\r
-\r
-Returns:\r
-\r
-  Status  - EFI_SUCCESS             if status code is successfully reported\r
-          - EFI_NOT_AVAILABLE_YET   if StatusCodePpi has not been installed\r
-\r
---*/\r
 {\r
   EFI_STATUS                Status;\r
   EFI_PEI_PROGRESS_CODE_PPI *StatusCodePpi;\r
@@ -87,7 +68,6 @@ Returns:
    return Status;   \r
   } \r
   \r
-  \r
   return  EFI_NOT_AVAILABLE_YET; \r
 }\r
 \r