apply for doxgen format.

[mirror_edk2.git] / MdeModulePkg / Core / RuntimeDxe / Crc32.c

diff --git a/MdeModulePkg/Core/RuntimeDxe/Crc32.c b/MdeModulePkg/Core/RuntimeDxe/Crc32.c
index f2c8f0227aa4bc48035317058ab6068a93d2b3bd..0e7e793365d2f1f5096e32c845b54747c763e0dd 100644 (file)
--- a/MdeModulePkg/Core/RuntimeDxe/Crc32.c
+++ b/MdeModulePkg/Core/RuntimeDxe/Crc32.c
@@ -1,13 +1,14 @@
-/*++\r
+/** @file\r
+  CalculateCrc32 Boot Services as defined in DXE CIS.\r
+\r
+Copyright (c) 2006, Intel Corporation. <BR>\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
+http://opensource.org/licenses/bsd-license.php\r
 \r
-Copyright (c) 2006, 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
-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
+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
 Module Name:\r
 \r
@@ -15,22 +16,30 @@ Module Name:
 \r
 Abstract:\r
 \r
-  CalculateCrc32 Boot Services as defined in DXE CIS.\r
-\r
   This Boot Services is in the Runtime Driver because this service is\r
   also required by SetVirtualAddressMap() when the EFI System Table and\r
-  EFI Runtime Services Table are converted from physical address to \r
+  EFI Runtime Services Table are converted from physical address to\r
   virtual addresses.  This requires that the 32-bit CRC be recomputed.\r
 \r
-Revision History:\r
-\r
---*/\r
+**/\r
 \r
 \r
 #include <PiDxe.h>\r
 \r
 UINT32  mCrcTable[256];\r
 \r
+/**\r
+  Calculate CRC32 for target data.\r
+\r
+  @param  Len                   The target data.\r
+  @param  DataSize              The target data size.\r
+  @param  CrcOut                The CRC32 for target data.\r
+\r
+  @retval EFI_SUCCESS           The CRC32 for target data is calculated successfully.\r
+  @retval EFI_INVALID_PARAMETER Some parameter is not valid, so the CRC32 is not\r
+                                calculated.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 RuntimeDriverCalculateCrc32 (\r
@@ -38,25 +47,6 @@ RuntimeDriverCalculateCrc32 (
   IN  UINTN   DataSize,\r
   OUT UINT32  *CrcOut\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Calculate CRC32 for target data\r
-\r
-Arguments:\r
-\r
-  Data     - The target data.\r
-  DataSize - The target data size.\r
-  CrcOut   - The CRC32 for target data.\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS           - The CRC32 for target data is calculated successfully.\r
-  EFI_INVALID_PARAMETER - Some parameter is not valid, so the CRC32 is not \r
-                          calculated.\r
-\r
---*/\r
 {\r
   UINT32  Crc;\r
   UINTN   Index;\r
@@ -75,26 +65,20 @@ Returns:
   return EFI_SUCCESS;\r
 }\r
 \r
-STATIC\r
-UINT32\r
-ReverseBits (\r
-  UINT32  Value\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
 \r
+/**\r
   Reverse bits for 32bit data.\r
 \r
-Arguments:\r
-\r
-  Value - the data to be reversed.\r
-\r
-Returns:\r
+  @param  Value                 The data to be reversed.\r
 \r
-  UINT32 data reversed.\r
+  @retrun                       Data reversed.\r
 \r
---*/\r
+**/\r
+STATIC\r
+UINT32\r
+ReverseBits (\r
+  UINT32  Value\r
+  )\r
 {\r
   UINTN   Index;\r
   UINT32  NewValue;\r
@@ -109,25 +93,18 @@ Returns:
   return NewValue;\r
 }\r
 \r
-VOID\r
-RuntimeDriverInitializeCrc32Table (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
+/**\r
   Initialize CRC32 table.\r
 \r
-Arguments:\r
-\r
-  None.\r
+  @param  None\r
 \r
-Returns:\r
+  @retrun None\r
 \r
-  None.\r
-\r
---*/\r
+**/\r
+VOID\r
+RuntimeDriverInitializeCrc32Table (\r
+  VOID\r
+  )\r
 {\r
   UINTN   TableEntry;\r
   UINTN   Index;\r