Refine the file/function comments to follow doxygen format

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

1 files changed, 16 insertions, 28 deletions

diff --git a/PcAtChipsetPkg/KbcResetDxe/ResetEntry.c b/PcAtChipsetPkg/KbcResetDxe/ResetEntry.c
index bcef440fcf..6e9917cbeb 100644
--- a/PcAtChipsetPkg/KbcResetDxe/ResetEntry.c
+++ b/PcAtChipsetPkg/KbcResetDxe/ResetEntry.c
@@ -1,17 +1,15 @@
-/*++

+/** @file

+  Driver entry for KbcReset driver.

 

-Copyright (c) 2009, Intel Corporation                                                         

-All rights reserved. This program and the accompanying materials                          

+Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved. <BR>

+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        

 http://opensource.org/licenses/bsd-license.php                                            

                                                                                           

 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

-

-

-

---*/

+**/

 

 #include "Reset.h"

 

@@ -21,33 +19,23 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 EFI_HANDLE  mResetHandle = NULL;

 

 

+/**

+  Initialize the state information for the Reset Architectural Protocol

+

+  @param ImageHandle     Handle of the loaded driver 

+  @param SystemTable     Pointer to the System Table

+

+  @retval EFI_SUCCESS           Thread can be successfully created

+  @retval EFI_OUT_OF_RESOURCES  Cannot allocate protocol data structure

+  @retval EFI_DEVICE_ERROR      Cannot create the timer service

+

+**/

 EFI_STATUS

 EFIAPI

 InitializeReset (

   IN EFI_HANDLE        ImageHandle,

   IN EFI_SYSTEM_TABLE  *SystemTable

   )

-/*++

-

-Routine Description:

-

-  Initialize the state information for the Reset Architectural Protocol

-

-Arguments:

-

-  ImageHandle of the loaded driver

-  Pointer to the System Table

-

-Returns:

-

-  Status

-

-  EFI_SUCCESS           - thread can be successfully created

-  EFI_OUT_OF_RESOURCES  - cannot allocate protocol data structure

-  EFI_DEVICE_ERROR      - cannot create the timer service

-

---*/

-// TODO:    SystemTable - add argument and description to function comment

 {

   EFI_STATUS  Status;