Update the function headers to Doxygen format.

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

diff --git a/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.c b/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.c
index ec0b9d837e49dc0e0639bcbd0165fe7f2adc712c..aad06afa2c08030476ba891e0dd6f6261b1eeb30 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.c
+++ b/MdeModulePkg/Universal/BdsDxe/HwErrRecSupport.c
@@ -15,27 +15,25 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "HwErrRecSupport.h"\r
 \r
-VOID\r
-InitializeHwErrRecSupport (\r
-  IN UINT16       HwErrRecSupportLevel\r
-  )\r
-/*++\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
-  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
+  @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
-  Returns:\r
+  @return VOID\r
 \r
---*/\r
+**/\r
+VOID\r
+InitializeHwErrRecSupport (\r
+  IN UINT16       HwErrRecSupportLevel\r
+  )\r
 {\r
   EFI_STATUS  Status;\r
 \r