sync comments, fix function header, rename variable name to follow coding style.

[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / HwErrRecSupport.c

diff --git a/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.c b/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.c
index 339361e1953dbd9d854e445becfdcf72848e3278..9ea6dbc554012e241c53e3d8d02ba07ef46d5b1c 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.c
+++ b/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.c
@@ -1,6 +1,8 @@
-/*++\r
+/** @file\r
+  Set the level of support for Hardware Error Record Persistence that is\r
+  implemented by the platform.\r
 \r
-Copyright (c) 2007, Intel Corporation\r
+Copyright (c) 2007 - 2008, Intel Corporation. <BR>\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
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -9,42 +11,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
-  HwErrRecSupport.c\r
+**/\r
 \r
-Abstract:\r
-\r
-  Set the level of support for Hardware Error Record Persistence that is\r
-  implemented by the platform.\r
+#include "HwErrRecSupport.h"\r
 \r
-Revision History\r
+/**\r
+  Set the HwErrRecSupport variable contains a binary UINT16 that supplies the\r
+  level of support for Hardware Error Record Persistence that is implemented\r
+  by the platform.\r
 \r
---*/\r
 \r
-#include "HwErrRecSupport.h"\r
+  @param HwErrRecSupportLevel\r
+                         zero value      - Indicates that the platform implements no support for\r
+                         Hardware Error Record Persistence.\r
+                         non-zero value  - Indicates that the platform implements Hardware Error\r
+                         Record Persistence.\r
 \r
+**/\r
 VOID\r
 InitializeHwErrRecSupport (\r
   IN UINT16       HwErrRecSupportLevel\r
   )\r
-/*++\r
-\r
-  Routine Description:\r
-    Set the HwErrRecSupport variable contains a binary UINT16 that supplies the\r
-    level of support for Hardware Error Record Persistence that is implemented\r
-    by the platform.\r
-\r
-  Arguments:\r
-    HwErrRecSupportLevel\r
-      zero value      - Indicates that the platform implements no support for\r
-                        Hardware Error Record Persistence.\r
-      non-zero value  - Indicates that the platform implements Hardware Error\r
-                        Record Persistence.\r
-\r
-  Returns:\r
-\r
---*/\r
 {\r
   EFI_STATUS  Status;\r
 \r