Correct the structure's comments to follow doxygen format.

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

11 files changed, 84 insertions, 112 deletions

diff --git a/IntelFrameworkPkg/Include/Ppi/BlockIo.h b/IntelFrameworkPkg/Include/Ppi/BlockIo.h
index 014cca5c1f..145139bf33 100644
--- a/IntelFrameworkPkg/Include/Ppi/BlockIo.h
+++ b/IntelFrameworkPkg/Include/Ppi/BlockIo.h
@@ -1,7 +1,7 @@
 /** @file

   This file declares BlockIo PPI used to access block-oriented storage devices

 

-  Copyright (c) 2007, Intel Corporation

+  Copyright (c) 2007 - 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

@@ -132,24 +132,24 @@ EFI_STATUS
   OUT VOID                                     *Buffer

   );

 

-/**

-  @par Ppi Description:

-  EFI_PEI_RECOVERY_BLOCK_IO_PPI provides the services that are required

-  to access a block I/O device during PEI recovery boot mode.

-

-  @param GetNumberOfBlockDevices

-  Gets the number of block I/O devices that the specific block driver manages.

-

-  @param GetBlockDeviceMediaInfo

-  Gets the specified media information.

-

-  @param ReadBlocks

-  Reads the requested number of blocks from the specified block device.

-

-**/

+///

+///  EFI_PEI_RECOVERY_BLOCK_IO_PPI provides the services that are required

+///  to access a block I/O device during PEI recovery boot mode.

+///

 struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI {

+  ///

+  /// Gets the number of block I/O devices that the specific block driver manages.

+  ///

   EFI_PEI_GET_NUMBER_BLOCK_DEVICES      GetNumberOfBlockDevices;

+  

+  ///

+  /// Gets the specified media information.

+  ///

   EFI_PEI_GET_DEVICE_MEDIA_INFORMATION  GetBlockDeviceMediaInfo;

+  

+  ///

+  /// Reads the requested number of blocks from the specified block device.

+  ///

   EFI_PEI_READ_BLOCKS                   ReadBlocks;

 };

 

diff --git a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
index cc803b66b5..bb6120b59d 100644
--- a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
+++ b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
@@ -8,7 +8,7 @@
   execution, the PEIM looks for a relevant PPI that is available to execute it, rather than executing it

   by issuing the native IA-32 instruction.

 

-  Copyright (c) 2007, Intel Corporation

+  Copyright (c) 2007 - 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

@@ -110,16 +110,11 @@ EFI_STATUS
   IN     EFI_GUID                                *FvFile OPTIONAL

   );

 

-/**

-  @par Ppi Description:

-  This PPI produces functions to interpret and execute the Framework boot script table.

-

-  @param Execute

-  Executes a boot script table.

-

-**/

+///

+/// This PPI produces functions to interpret and execute the Framework boot script table.

+///

 struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI {

-  EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;

+  EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;  ///< Executes a boot script table.

 };

 

 extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;

diff --git a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
index 74d12595c8..aee8d0cd46 100644
--- a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
+++ b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
@@ -8,7 +8,7 @@
   module determines the internal search order, with capsule number 1 as the highest load priority and

   number N as the lowest priority.

 

-  Copyright (c) 2007, Intel Corporation

+  Copyright (c) 2007 - 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

@@ -112,24 +112,24 @@ EFI_STATUS
   OUT VOID                                        *Buffer

   );

 

-/**

-  @par Ppi Description:

-  Presents a standard interface to EFI_PEI_DEVICE_RECOVERY_MODULE_PPI,

-  regardless of the underlying device(s).

-

-  @param GetNumberRecoveryCapsules

-  Returns the number of DXE capsules that were found.

-

-  @param GetRecoveryCapsuleInfo

-  Returns the capsule image type and the size of a given image.

-

-  @param LoadRecoveryCapsule

-  Loads a DXE capsule into memory

-

-**/

+///

+/// Presents a standard interface to EFI_PEI_DEVICE_RECOVERY_MODULE_PPI,

+/// regardless of the underlying device(s).

+///

 struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI {

+  ///

+  /// Returns the number of DXE capsules that were found.

+  ///

   EFI_PEI_DEVICE_GET_NUMBER_RECOVERY_CAPSULE  GetNumberRecoveryCapsules;

+  

+  ///

+  /// Returns the capsule image type and the size of a given image.

+  ///

   EFI_PEI_DEVICE_GET_RECOVERY_CAPSULE_INFO    GetRecoveryCapsuleInfo;

+  

+  ///

+  /// Loads a DXE capsule into memory

+  ///

   EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE        LoadRecoveryCapsule;

 };

 

diff --git a/IntelFrameworkPkg/Include/Ppi/FindFv.h b/IntelFrameworkPkg/Include/Ppi/FindFv.h
index d7206d2b0a..4af010bdc9 100644
--- a/IntelFrameworkPkg/Include/Ppi/FindFv.h
+++ b/IntelFrameworkPkg/Include/Ppi/FindFv.h
@@ -1,7 +1,7 @@
 /** @file

   This file declares FindFv PPI used to locate FVs that contain PEIMs in PEI

 

-  Copyright (c) 2007, Intel Corporation

+  Copyright (c) 2007 - 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

@@ -55,17 +55,12 @@ EFI_STATUS
   );

 

 /**

-  @par Ppi Description:

   Hardware mechanisms for locating FVs in a platform vary widely.

   EFI_PEI_FIND_FV_PPI serves to abstract this variation so that the

   PEI Foundation can remain standard across a wide variety of platforms.

-

-  @param FindFv

-  Service that abstracts the location of additional firmware volumes.

-

 **/

 struct _EFI_PEI_FIND_FV_PPI {

-  EFI_PEI_FIND_FV_FINDFV  FindFv;

+  EFI_PEI_FIND_FV_FINDFV  FindFv;   ///< Service that abstracts the location of additional firmware volumes.

 };

 

 extern EFI_GUID gEfiFindFvPpiGuid;

diff --git a/IntelFrameworkPkg/Include/Ppi/FvLoadFile.h b/IntelFrameworkPkg/Include/Ppi/FvLoadFile.h
index abe4f3a6d2..3c66b32f1c 100644
--- a/IntelFrameworkPkg/Include/Ppi/FvLoadFile.h
+++ b/IntelFrameworkPkg/Include/Ppi/FvLoadFile.h
@@ -1,7 +1,7 @@
 /** @file

   Load image file from fv to memory.

 

-  Copyright (c) 2007, Intel Corporation

+  Copyright (c) 2007 - 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

@@ -53,16 +53,15 @@ EFI_STATUS
   );

 

 /**

-  @par Ppi Description:

   This PPI is a pointer to the Load File service. This service will be

   published by a PEIM.The PEI Foundation will use this service to

-  launch the known non-XIP PE/COFF PEIM images.  This service may

+  launch the known non-XIP PE/COFF PEIM images. This service may

   depend upon the presence of the EFI_PEI_PERMANENT_MEMORY_INSTALLED_PPI.

 **/

 struct _EFI_PEI_FV_FILE_LOADER_PPI {

-///

-/// Loads a PEIM into memory for subsequent execution

-///

+  ///

+  /// Loads a PEIM into memory for subsequent execution

+  ///

   EFI_PEI_FV_LOAD_FILE  FvLoadFile;

 };

 

diff --git a/IntelFrameworkPkg/Include/Ppi/PciCfg.h b/IntelFrameworkPkg/Include/Ppi/PciCfg.h
index 34773fc472..3f4398a3c6 100644
--- a/IntelFrameworkPkg/Include/Ppi/PciCfg.h
+++ b/IntelFrameworkPkg/Include/Ppi/PciCfg.h
@@ -1,7 +1,7 @@
 /** @file

   This file declares PciCfg PPI used to access PCI configuration space in PEI

 

-  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        

@@ -90,20 +90,21 @@ EFI_STATUS
 /**

   The EFI_PEI_PCI_CFG_PPI interfaces are used to abstract accesses to PCI 

   controllers behind a PCI root bridge controller.

-

-  @param Read

-  PCI read services.  See the Read() function description.

-

-  @param Write

-  PCI write services.  See the Write() function description.

-

-  @param Modify

-  PCI read-modify-write services.  See the Modify() function description.

-

 **/

 struct _EFI_PEI_PCI_CFG_PPI {

+  ///

+  /// PCI read services.  See the Read() function description.

+  ///

   EFI_PEI_PCI_CFG_PPI_IO  Read;

+  

+  ///

+  /// PCI write services.  See the Write() function description.

+  ///

   EFI_PEI_PCI_CFG_PPI_IO  Write;

+  

+  ///

+  /// PCI read-modify-write services.  See the Modify() function description.

+  ///

   EFI_PEI_PCI_CFG_PPI_RW  Modify;

 };

 

diff --git a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
index b757662201..c93ad26647 100644
--- a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
+++ b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
@@ -6,7 +6,7 @@
   storage; as such, a write command to certain technologies would alter the contents of the entire part,

   thus making the in situ PEIM execution not follow the required flow.

 

-  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

@@ -106,20 +106,12 @@ EFI_STATUS
   );

 

 /**

-  @par Ppi Description:

   This PPI provides a lightweight, read-only variant of the full EFI

   variable services.

-

-  @param GetVariable

-  A service to ascertain a given variable name.

-

-  @param GetNextVariableName

-  A service to ascertain a variable based upon a given, known variable

-

 **/

 struct _EFI_PEI_READ_ONLY_VARIABLE_PPI {

-  EFI_PEI_GET_VARIABLE            PeiGetVariable;

-  EFI_PEI_GET_NEXT_VARIABLE_NAME  PeiGetNextVariableName;

+  EFI_PEI_GET_VARIABLE            PeiGetVariable;         ///< A service to ascertain a given variable name.

+  EFI_PEI_GET_NEXT_VARIABLE_NAME  PeiGetNextVariableName; ///< A service to ascertain a variable based upon a given, known variable

 };

 

 extern EFI_GUID gEfiPeiReadOnlyVariablePpiGuid;

diff --git a/IntelFrameworkPkg/Include/Ppi/RecoveryModule.h b/IntelFrameworkPkg/Include/Ppi/RecoveryModule.h
index 5637c8092d..f4c7467fdd 100644
--- a/IntelFrameworkPkg/Include/Ppi/RecoveryModule.h
+++ b/IntelFrameworkPkg/Include/Ppi/RecoveryModule.h
@@ -2,7 +2,7 @@
   This file declares Recovery Module PPI. 

   This PPI is used to find and load the recovery files.

 

-  Copyright (c) 2007, Intel Corporation

+  Copyright (c) 2007 - 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

@@ -51,15 +51,10 @@ EFI_STATUS
   );

 

 /**

-  @par Ppi Description:

   Finds and loads the recovery files.

-

-  @param LoadRecoveryCapsule

-  Loads a DXE binary capsule into memory.

-

 **/

 struct _EFI_PEI_RECOVERY_MODULE_PPI {

-  EFI_PEI_LOAD_RECOVERY_CAPSULE LoadRecoveryCapsule;

+  EFI_PEI_LOAD_RECOVERY_CAPSULE LoadRecoveryCapsule;  ///< Loads a DXE binary capsule into memory.

 };

 

 extern EFI_GUID gEfiPeiRecoveryModulePpiGuid;

diff --git a/IntelFrameworkPkg/Include/Ppi/S3Resume.h b/IntelFrameworkPkg/Include/Ppi/S3Resume.h
index 4629611088..2509eb53b6 100644
--- a/IntelFrameworkPkg/Include/Ppi/S3Resume.h
+++ b/IntelFrameworkPkg/Include/Ppi/S3Resume.h
@@ -64,15 +64,14 @@ EFI_STATUS
   );

 

 /**

-  @par Ppi Description:

   EFI_PEI_S3_RESUME_PPI accomplishes the firmware S3 resume boot

   path and transfers control to OS.

 **/

 struct _EFI_PEI_S3_RESUME_PPI {

-///

-/// Restores the platform to its preboot configuration for an S3 resume and

-/// jumps to the OS waking vector.

-///

+  ///

+  /// Restores the platform to its preboot configuration for an S3 resume and

+  /// jumps to the OS waking vector.

+  ///

   EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG  S3RestoreConfig;

 };

 

diff --git a/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h b/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h
index 5f0dde5775..53e3d387cc 100644
--- a/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h
+++ b/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h
@@ -95,16 +95,11 @@ EFI_STATUS
   );

 

 /**

-  @par Ppi Description:

   This PPI supports encapsulating sections, such as GUIDed sections used to

   authenticate the file encapsulation of other domain-specific wrapping.

-

-  @param GetSection

-  Retrieves a section from within a section file.

-

 **/

 struct _EFI_PEI_SECTION_EXTRACTION_PPI {

-  EFI_PEI_GET_SECTION PeiGetSection;

+  EFI_PEI_GET_SECTION PeiGetSection;  ///< Retrieves a section from within a section file.

 };

 

 extern EFI_GUID gEfiPeiSectionExtractionPpiGuid;

diff --git a/IntelFrameworkPkg/Include/Ppi/Smbus.h b/IntelFrameworkPkg/Include/Ppi/Smbus.h
index dff06ce7bb..77f52af66a 100644
--- a/IntelFrameworkPkg/Include/Ppi/Smbus.h
+++ b/IntelFrameworkPkg/Include/Ppi/Smbus.h
@@ -2,7 +2,7 @@
   This file declares Smbus PPI which provides the basic I/O interfaces that a PEIM 

   uses to access its SMBus controller and the slave devices attached to it.

 

-  Copyright (c) 2007, Intel Corporation

+  Copyright (c) 2007 - 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

@@ -183,29 +183,30 @@ EFI_STATUS
   );

 

 /**

-  @par Ppi Description:

   Provides the basic I/O interfaces that a PEIM uses to access

   its SMBus controller and the slave devices attached to it.

-

-  @param Execute

-  Executes the SMBus operation to an SMBus slave device.

-

-  @param ArpDevice

-  Allows an SMBus 2.0 device(s) to be Address Resolution Protocol (ARP)

-

-  @param GetArpMap

-  Allows a PEIM to retrieve the address that was allocated by the SMBus

-  host controller during enumeration/ARP.

-

-  @param Notify

-  Allows a driver to register for a callback to the SMBus host

-  controller driver when the bus issues a notification to the bus controller PEIM.

-

 **/

 struct _EFI_PEI_SMBUS_PPI {

+  ///

+  /// Executes the SMBus operation to an SMBus slave device.

+  ///

   EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION Execute;

+  

+  ///

+  /// Allows an SMBus 2.0 device(s) to be Address Resolution Protocol (ARP)

+  ///

   EFI_PEI_SMBUS_PPI_ARP_DEVICE        ArpDevice;

+  

+  ///

+  /// Allows a PEIM to retrieve the address that was allocated by the SMBus

+  /// host controller during enumeration/ARP.  

+  ///

   EFI_PEI_SMBUS_PPI_GET_ARP_MAP       GetArpMap;

+  

+  ///

+  /// Allows a driver to register for a callback to the SMBus host

+  /// controller driver when the bus issues a notification to the bus controller PEIM.  

+  ///

   EFI_PEI_SMBUS_PPI_NOTIFY            Notify;

 };