apply for doxgen format.

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

3 files changed, 52 insertions, 76 deletions

diff --git a/MdeModulePkg/Core/RuntimeDxe/Crc32.c b/MdeModulePkg/Core/RuntimeDxe/Crc32.c
index f2c8f0227a..0e7e793365 100644
--- a/MdeModulePkg/Core/RuntimeDxe/Crc32.c
+++ b/MdeModulePkg/Core/RuntimeDxe/Crc32.c
@@ -1,13 +1,14 @@
-/*++

+/** @file

+  CalculateCrc32 Boot Services as defined in DXE CIS.

+

+Copyright (c) 2006, Intel Corporation. <BR>

+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

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

 

-Copyright (c) 2006, 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        

-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.             

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

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

 

 Module Name:

 

@@ -15,22 +16,30 @@ Module Name:
 

 Abstract:

 

-  CalculateCrc32 Boot Services as defined in DXE CIS.

-

   This Boot Services is in the Runtime Driver because this service is

   also required by SetVirtualAddressMap() when the EFI System Table and

-  EFI Runtime Services Table are converted from physical address to 

+  EFI Runtime Services Table are converted from physical address to

   virtual addresses.  This requires that the 32-bit CRC be recomputed.

 

-Revision History:

-

---*/

+**/

 

 

 #include <PiDxe.h>

 

 UINT32  mCrcTable[256];

 

+/**

+  Calculate CRC32 for target data.

+

+  @param  Len                   The target data.

+  @param  DataSize              The target data size.

+  @param  CrcOut                The CRC32 for target data.

+

+  @retval EFI_SUCCESS           The CRC32 for target data is calculated successfully.

+  @retval EFI_INVALID_PARAMETER Some parameter is not valid, so the CRC32 is not

+                                calculated.

+

+**/

 EFI_STATUS

 EFIAPI

 RuntimeDriverCalculateCrc32 (

@@ -38,25 +47,6 @@ RuntimeDriverCalculateCrc32 (
   IN  UINTN   DataSize,

   OUT UINT32  *CrcOut

   )

-/*++

-

-Routine Description:

-

-  Calculate CRC32 for target data

-

-Arguments:

-

-  Data     - The target data.

-  DataSize - The target data size.

-  CrcOut   - The CRC32 for target data.

-

-Returns:

-

-  EFI_SUCCESS           - The CRC32 for target data is calculated successfully.

-  EFI_INVALID_PARAMETER - Some parameter is not valid, so the CRC32 is not 

-                          calculated.

-

---*/

 {

   UINT32  Crc;

   UINTN   Index;

@@ -75,26 +65,20 @@ Returns:
   return EFI_SUCCESS;

 }

 

-STATIC

-UINT32

-ReverseBits (

-  UINT32  Value

-  )

-/*++

-

-Routine Description:

 

+/**

   Reverse bits for 32bit data.

 

-Arguments:

-

-  Value - the data to be reversed.

-

-Returns:

+  @param  Value                 The data to be reversed.

 

-  UINT32 data reversed.

+  @retrun                       Data reversed.

 

---*/

+**/

+STATIC

+UINT32

+ReverseBits (

+  UINT32  Value

+  )

 {

   UINTN   Index;

   UINT32  NewValue;

@@ -109,25 +93,18 @@ Returns:
   return NewValue;

 }

 

-VOID

-RuntimeDriverInitializeCrc32Table (

-  VOID

-  )

-/*++

-

-Routine Description:

-

+/**

   Initialize CRC32 table.

 

-Arguments:

-

-  None.

+  @param  None

 

-Returns:

+  @retrun None

 

-  None.

-

---*/

+**/

+VOID

+RuntimeDriverInitializeCrc32Table (

+  VOID

+  )

 {

   UINTN   TableEntry;

   UINTN   Index;

diff --git a/MdeModulePkg/Core/RuntimeDxe/Runtime.c b/MdeModulePkg/Core/RuntimeDxe/Runtime.c
index 1f09fa383f..efd7dec05c 100644
--- a/MdeModulePkg/Core/RuntimeDxe/Runtime.c
+++ b/MdeModulePkg/Core/RuntimeDxe/Runtime.c
@@ -1,6 +1,7 @@
-/*++

+/** @file

+  Runtime Architectural Protocol as defined in the DXE CIS.

 

-Copyright (c) 2006, Intel Corporation

+Copyright (c) 2006, Intel Corporation. <BR>

 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

@@ -15,8 +16,6 @@ Module Name:
 

 Abstract:

 

-  Runtime Architectural Protocol as defined in the DXE CIS

-

   This code is used to produce the EFI runtime virtual switch over

 

   THIS IS VERY DANGEROUS CODE BE VERY CAREFUL IF YOU CHANGE IT

@@ -49,7 +48,7 @@ Revision History:
   Runtime Arch Protocol definition no longer contains CalculateCrc32. Boot Service

   Table now contains an item named CalculateCrc32.

 

---*/

+**/

 

 #include "Runtime.h"

 

@@ -367,7 +366,7 @@ Returns:
 

   //

   // UEFI don't require System Configuration Tables Conversion.

-  // 

+  //

 

   //

   // Convert the runtime fields of the EFI System Table and recompute the CRC-32

diff --git a/MdeModulePkg/Core/RuntimeDxe/Runtime.h b/MdeModulePkg/Core/RuntimeDxe/Runtime.h
index 0078da2b91..4ff21ea5b6 100644
--- a/MdeModulePkg/Core/RuntimeDxe/Runtime.h
+++ b/MdeModulePkg/Core/RuntimeDxe/Runtime.h
@@ -1,25 +1,25 @@
-/*++

+/** @file

+  Runtime Architectural Protocol as defined in the DXE CIS.

 

-Copyright (c) 2006, Intel Corporation

+Copyright (c) 2006, Intel Corporation. <BR>

 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

 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.

 

+

 Module Name:

 

   Runtime.h

 

 Abstract:

 

-  Runtime Architectural Protocol as defined in the DXE CIS

-

   This code is used to produce the EFI runtime architectural protocol.

 

---*/

+**/

 

 #ifndef _RUNTIME_H_

 #define _RUNTIME_H_