Refine comments.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8642 6f19259b-4bc3-4df7-8a09-765794883524

IntelFrameworkModulePkg/Universal/DataHubStdErrDxe/DataHubStdErr.c

@@ -2,7 +2,7 @@
   Data Hub filter driver that takes DEBUG () info from Data Hub and writes it
   to StdErr if it exists.
 
-Copyright (c) 2006, Intel Corporation
+Copyright (c) 2006 - 2009, Intel Corporation
 All rights reserved. This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD License
 which accompanies this distribution.  The full text of the license may be found at
@@ -13,10 +13,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
 **/
 
-
 #include <FrameworkDxe.h>
-
-
 #include <Guid/DataHubStatusCodeRecord.h>
 #include <Guid/StatusCodeDataTypeId.h>
 #include <Guid/StatusCodeDataTypeDebug.h>
@@ -36,8 +33,8 @@ EFI_EVENT             mDataHubStdErrEvent;
   Event handler registered with the Data Hub to parse EFI_DEBUG_CODE. This
   handler reads the Data Hub and sends any DEBUG info to StdErr.
 
-  @param Event    - The event that occured, not used
+  @param Event      The event that occured, not used
-  @param Context  - DataHub Protocol Pointer
+  @param Context    DataHub Protocol Pointer
 **/
 VOID
 EFIAPI
@@ -68,6 +65,7 @@ DataHubStdErrEventHandler (
   if (gST->StdErr == NULL) {
     return ;
   }
+  
   //
   // Mtc of zero means return the next record that has not been read by the
   // event handler.
@@ -100,12 +98,11 @@ DataHubStdErrEventHandler (
   Register an event handler with the Data Hub to parse EFI_DEBUG_CODE. This
   handler reads the Data Hub and sends any DEBUG info to StdErr.
 
-  @param ImageHandle - Image handle of this driver.
+  @param ImageHandle                Image handle of this driver.
-  @param SystemTable - Pointer to EFI system table.
+  @param SystemTable                Pointer to EFI system table.
 
-  @retval EFI_SUCCESS             - The event handler was registered.
+  @retval EFI_SUCCESS               The event handler was registered.
-  @retval EFI_OUT_OF_RESOURCES    - The event hadler was not registered due to lack of
+  @retval EFI_OUT_OF_RESOURCES      The event hadler was not registered due to lack of system resources.
-                            system resources.
 **/
 EFI_STATUS
 EFIAPI

IntelFrameworkModulePkg/Universal/DataHubStdErrDxe/DataHubStdErrDxe.inf

@@ -1,7 +1,6 @@
 #/** @file
-#  Component description file for Data Hub filter driver.
-#
 #  This driver takes DEBUG () info from Data Hub and writes it to StdErr if it exists.
+#
 #  Copyright (c) 2006 - 2009, Intel Corporation
 #
 #  All rights reserved. This program and the accompanying materials
@@ -11,7 +10,6 @@
 #  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 #  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #
-#
 #**/
 
 [Defines]
@@ -37,24 +35,19 @@
   IntelFrameworkPkg/IntelFrameworkPkg.dec
   IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec
 
-
-
-
 [LibraryClasses]
   UefiBootServicesTableLib
   BaseMemoryLib
   UefiDriverEntryPoint
   DebugLib
 
-
 [Guids]
   gEfiStatusCodeDataTypeDebugGuid               # SOMETIMES_CONSUMED
   gEfiDataHubStatusCodeRecordGuid               # SOMETIMES_CONSUMED
 
 
 [Protocols]
-  gEfiDataHubProtocolGuid                       # PROTOCOL ALWAYS_CONSUMED
+  gEfiDataHubProtocolGuid                       # PROTOCOL CONSUMED
-
 
 [Depex]
   gEfiDataHubProtocolGuid