Formalize comments for Protocols and PPIs.

1. Use doxygen format for Protocol/PPI data structure
2. Remove doxygen comments for function elements in Protocol/Ppi
3. Use doxygen format for data elements in Protocol/Ppi, and add missing comments where necessary
4. PEI Services Table is also updated accordingly.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6107 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
xli24
2008-10-13 02:54:29 +00:00
parent 66eebcf94f
commit 44717a398f
103 changed files with 576 additions and 1012 deletions

View File

@@ -209,23 +209,9 @@ EFI_STATUS
/// its SMBus controller and the slave devices attached to it.
///
struct _EFI_PEI_SMBUS2_PPI {
///
/// Executes the SMBus operation to an SMBus slave device.
///
EFI_PEI_SMBUS2_PPI_EXECUTE_OPERATION Execute;
///
/// Allows an SMBus 2.0 device(s) to be Address Resolution Protocol (ARP).
///
EFI_PEI_SMBUS2_PPI_ARP_DEVICE ArpDevice;
///
/// Allows a PEIM to retrieve the address that was allocated by the SMBus
/// host controller during enumeration/ARP.
///
EFI_PEI_SMBUS2_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_SMBUS2_PPI_NOTIFY Notify;
///
/// Identifier which uniquely identifies this SMBus controller in a system.