Refine the file/function comments to follow doxygen format

[mirror_edk2.git] / PcAtChipsetPkg / KbcResetDxe / ResetEntry.c

diff --git a/PcAtChipsetPkg/KbcResetDxe/ResetEntry.c b/PcAtChipsetPkg/KbcResetDxe/ResetEntry.c
index bcef440fcf3ef083583f1d65d3e60522a9ffb7e7..6e9917cbebb21dc62be39645580b7087856af409 100644 (file)
--- a/PcAtChipsetPkg/KbcResetDxe/ResetEntry.c
+++ b/PcAtChipsetPkg/KbcResetDxe/ResetEntry.c
@@ -1,17 +1,15 @@
-/*++\r
+/** @file\r
+  Driver entry for KbcReset driver.\r
 \r
-Copyright (c) 2009, Intel Corporation                                                         \r
-All rights reserved. This program and the accompanying materials                          \r
+Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved. <BR>\r
+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
 http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                           \r
 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
-\r
-\r
---*/\r
+**/\r
 \r
 #include "Reset.h"\r
 \r
@@ -21,33 +19,23 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 EFI_HANDLE  mResetHandle = NULL;\r
 \r
 \r
+/**\r
+  Initialize the state information for the Reset Architectural Protocol\r
+\r
+  @param ImageHandle     Handle of the loaded driver \r
+  @param SystemTable     Pointer to the System Table\r
+\r
+  @retval EFI_SUCCESS           Thread can be successfully created\r
+  @retval EFI_OUT_OF_RESOURCES  Cannot allocate protocol data structure\r
+  @retval EFI_DEVICE_ERROR      Cannot create the timer service\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 InitializeReset (\r
   IN EFI_HANDLE        ImageHandle,\r
   IN EFI_SYSTEM_TABLE  *SystemTable\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Initialize the state information for the Reset Architectural Protocol\r
-\r
-Arguments:\r
-\r
-  ImageHandle of the loaded driver\r
-  Pointer to the System Table\r
-\r
-Returns:\r
-\r
-  Status\r
-\r
-  EFI_SUCCESS           - thread can be successfully created\r
-  EFI_OUT_OF_RESOURCES  - cannot allocate protocol data structure\r
-  EFI_DEVICE_ERROR      - cannot create the timer service\r
-\r
---*/\r
-// TODO:    SystemTable - add argument and description to function comment\r
 {\r
   EFI_STATUS  Status;\r
 \r