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:
@@ -705,20 +705,19 @@ EFI_STATUS
|
||||
);
|
||||
|
||||
|
||||
/**
|
||||
@par Protocol Description:
|
||||
The Firmware Volume Protocol contains the file-level
|
||||
abstraction to the firmware volume as well as some firmware
|
||||
volume attribute reporting and configuration services. The
|
||||
Firmware Volume Protocol is the interface used by all parts of
|
||||
DXE that are not directly involved with managing the firmware
|
||||
volume itself. This abstraction allows many varied types of
|
||||
firmware volume implementations. A firmware volume may be a
|
||||
flash device or it may be a file in the UEFI system partition,
|
||||
for example. This level of firmware volume implementation
|
||||
detail is not visible to the consumers of the Firmware Volume
|
||||
Protocol.
|
||||
**/
|
||||
///
|
||||
/// The Firmware Volume Protocol contains the file-level
|
||||
/// abstraction to the firmware volume as well as some firmware
|
||||
/// volume attribute reporting and configuration services. The
|
||||
/// Firmware Volume Protocol is the interface used by all parts of
|
||||
/// DXE that are not directly involved with managing the firmware
|
||||
/// volume itself. This abstraction allows many varied types of
|
||||
/// firmware volume implementations. A firmware volume may be a
|
||||
/// flash device or it may be a file in the UEFI system partition,
|
||||
/// for example. This level of firmware volume implementation
|
||||
/// detail is not visible to the consumers of the Firmware Volume
|
||||
/// Protocol.
|
||||
///
|
||||
struct _EFI_FIRMWARE_VOLUME2_PROTOCOL {
|
||||
EFI_FV_GET_ATTRIBUTES GetVolumeAttributes;
|
||||
EFI_FV_SET_ATTRIBUTES SetVolumeAttributes;
|
||||
|
Reference in New Issue
Block a user