Update the copyright notice format

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

diff --git a/MdeModulePkg/Core/Pei/BootMode/BootMode.c b/MdeModulePkg/Core/Pei/BootMode/BootMode.c
index fbfd02f84c40091a2806c4d942b0fc13fea4cf9c..39afeba83843cd558c45ff243fd18f60cdb55049 100644 (file)
--- a/MdeModulePkg/Core/Pei/BootMode/BootMode.c
+++ b/MdeModulePkg/Core/Pei/BootMode/BootMode.c
@@ -1,7 +1,12 @@
-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation                                                         \r
-All rights reserved. This program and the accompanying materials                          \r
+/** @file\r
+  This module provide function for ascertaining and updating the boot mode:\r
+  GetBootMode()\r
+  SetBootMode()\r
+  See PI Specification volume I, chapter 9 Boot Paths for additional information\r
+  on the boot mode.\r
+  \r
+Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+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
 http://opensource.org/licenses/bsd-license.php                                            \r
@@ -9,47 +14,28 @@ 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
-  BootMode.c\r
-\r
-Abstract:\r
+**/\r
 \r
-  EFI PEI Core Boot Mode services\r
+#include "PeiMain.h"\r
 \r
+/**\r
+  This service enables PEIMs to ascertain the present value of the boot mode.\r
 \r
+  @param PeiServices            An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param BootMode               A pointer to contain the value of the boot mode.\r
 \r
-Revision History\r
-\r
---*/\r
-\r
-#include <PeiMain.h>\r
+  @retval EFI_SUCCESS           The boot mode was returned successfully.\r
+  @retval EFI_INVALID_PARAMETER BootMode is NULL.\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PeiGetBootMode (\r
-  IN CONST EFI_PEI_SERVICES  **PeiServices,\r
-  OUT EFI_BOOT_MODE          *BootMode\r
+  IN  CONST EFI_PEI_SERVICES  **PeiServices,\r
+  IN  OUT   EFI_BOOT_MODE     *BootMode\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  This service enables PEIMs to ascertain the present value of the boot mode.  \r
-\r
-Arguments:\r
-\r
-  PeiServices    - The PEI core services table.\r
-  BootMode       - A pointer to contain the value of the boot mode. \r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS           - The boot mode was returned successfully.\r
-  EFI_INVALID_PARAMETER - BootMode is NULL.\r
-\r
---*/\r
 {\r
-  PEI_CORE_INSTANCE                    *PrivateData;    \r
+  PEI_CORE_INSTANCE             *PrivateData;    \r
   EFI_HOB_HANDOFF_INFO_TABLE    *HandOffHob;\r
 \r
 \r
@@ -68,28 +54,22 @@ Returns:
 }\r
 \r
 \r
+/**\r
+  This service enables PEIMs to update the boot mode variable.\r
+\r
+\r
+  @param PeiServices      An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param BootMode         The value of the boot mode to set.\r
+\r
+  @return EFI_SUCCESS     The value was successfully updated\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PeiSetBootMode (\r
   IN CONST EFI_PEI_SERVICES  **PeiServices,\r
   IN EFI_BOOT_MODE           BootMode\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  This service enables PEIMs to update the boot mode variable.    \r
-\r
-Arguments:\r
-\r
-  PeiServices    - The PEI core services table.\r
-  BootMode       - The value of the boot mode to set.\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS    - The value was successfully updated\r
-\r
---*/\r
 {\r
   PEI_CORE_INSTANCE                    *PrivateData;    \r
   EFI_HOB_HANDOFF_INFO_TABLE    *HandOffHob;\r