Add comments for the return value of GenericBdsLib functions.

[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / DataHubStdErrDxe / DataHubStdErr.c

diff --git a/IntelFrameworkModulePkg/Universal/DataHubStdErrDxe/DataHubStdErr.c b/IntelFrameworkModulePkg/Universal/DataHubStdErrDxe/DataHubStdErr.c
index 34ef690d76d8cf617f192b112cd4d45accd1c9b8..7dd893b3b8eb709a35207710937e83fd6806b6bc 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/DataHubStdErrDxe/DataHubStdErr.c
+++ b/IntelFrameworkModulePkg/Universal/DataHubStdErrDxe/DataHubStdErr.c
@@ -1,8 +1,8 @@
-/**@file\r
+/** @file\r
   Data Hub filter driver that takes DEBUG () info from Data Hub and writes it\r
   to StdErr if it exists.\r
 \r
-Copyright (c) 2006, Intel Corporation\r
+Copyright (c) 2006 - 2009, 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
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -13,12 +13,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-\r
 #include <FrameworkDxe.h>\r
-\r
-\r
 #include <Guid/DataHubStatusCodeRecord.h>\r
 #include <Guid/StatusCodeDataTypeId.h>\r
+#include <Guid/StatusCodeDataTypeDebug.h>\r
 #include <Protocol/DataHub.h>\r
 #include <Protocol/SimpleTextOut.h>\r
 \r
@@ -35,10 +33,9 @@ EFI_EVENT             mDataHubStdErrEvent;
   Event handler registered with the Data Hub to parse EFI_DEBUG_CODE. This\r
   handler reads the Data Hub and sends any DEBUG info to StdErr.\r
 \r
-  @param Event    - The event that occured, not used\r
-  @param Context  - DataHub Protocol Pointer\r
+  @param Event      The event that occured, not used\r
+  @param Context    DataHub Protocol Pointer\r
 **/\r
-STATIC\r
 VOID\r
 EFIAPI\r
 DataHubStdErrEventHandler (\r
@@ -68,6 +65,7 @@ DataHubStdErrEventHandler (
   if (gST->StdErr == NULL) {\r
     return ;\r
   }\r
+  \r
   //\r
   // Mtc of zero means return the next record that has not been read by the\r
   // event handler.\r
@@ -100,12 +98,11 @@ DataHubStdErrEventHandler (
   Register an event handler with the Data Hub to parse EFI_DEBUG_CODE. This\r
   handler reads the Data Hub and sends any DEBUG info to StdErr.\r
 \r
-  @param ImageHandle - Image handle of this driver.\r
-  @param SystemTable - Pointer to EFI system table.\r
+  @param ImageHandle                Image handle of this driver.\r
+  @param SystemTable                Pointer to EFI system table.\r
 \r
-  @retval EFI_SUCCESS             - The event handler was registered.\r
-  @retval EFI_OUT_OF_RESOURCES    - The event hadler was not registered due to lack of\r
-                            system resources.\r
+  @retval EFI_SUCCESS               The event handler was registered.\r
+  @retval EFI_OUT_OF_RESOURCES      The event hadler was not registered due to lack of system resources.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r