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:
@@ -552,13 +552,12 @@ EFI_STATUS
|
||||
//
|
||||
#define EFI_SIMPLE_NETWORK_INTERFACE_REVISION EFI_SIMPLE_NETWORK_PROTOCOL_REVISION
|
||||
|
||||
/**
|
||||
@par Protocol Description:
|
||||
The EFI_SIMPLE_NETWORK_PROTOCOL protocol is used to initialize access
|
||||
to a network adapter. Once the network adapter initializes,
|
||||
the EFI_SIMPLE_NETWORK_PROTOCOL protocol provides services that
|
||||
allow packets to be transmitted and received.
|
||||
**/
|
||||
///
|
||||
/// The EFI_SIMPLE_NETWORK_PROTOCOL protocol is used to initialize access
|
||||
/// to a network adapter. Once the network adapter initializes,
|
||||
/// the EFI_SIMPLE_NETWORK_PROTOCOL protocol provides services that
|
||||
/// allow packets to be transmitted and received.
|
||||
///
|
||||
struct _EFI_SIMPLE_NETWORK_PROTOCOL {
|
||||
///
|
||||
/// Revision of the EFI_SIMPLE_NETWORK_PROTOCOL. All future revisions must
|
||||
@@ -583,6 +582,9 @@ struct _EFI_SIMPLE_NETWORK_PROTOCOL {
|
||||
/// Event used with WaitForEvent() to wait for a packet to be received.
|
||||
///
|
||||
EFI_EVENT WaitForPacket;
|
||||
///
|
||||
/// Pointer to the EFI_SIMPLE_NETWORK_MODE data for the device.
|
||||
///
|
||||
EFI_SIMPLE_NETWORK_MODE *Mode;
|
||||
};
|
||||
|
||||
|
Reference in New Issue
Block a user