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:
@@ -328,30 +328,15 @@ EFI_STATUS
|
||||
...
|
||||
);
|
||||
|
||||
/**
|
||||
@par Protocol Description:
|
||||
The Firmware Volume Block Protocol is the low-level interface
|
||||
to a firmware volume. File-level access to a firmware volume
|
||||
should not be done using the Firmware Volume Block Protocol.
|
||||
Normal access to a firmware volume must use the Firmware
|
||||
Volume Protocol. Typically, only the file system driver that
|
||||
produces the Firmware Volume Protocol will bind to the
|
||||
Firmware Volume Block Protocol. The Firmware Volume Block
|
||||
Protocol provides the following:
|
||||
- Byte-level read/write functionality.
|
||||
- Block-level erase functionality.
|
||||
- It further exposes device-hardening features, such as may be
|
||||
equired to protect the firmware from unwanted overwriting
|
||||
and/or erasure.
|
||||
- It is useful to layer a file system driver on top of the
|
||||
Firmware Volume Block Protocol.
|
||||
|
||||
This file system driver produces the Firmware Volume Protocol,
|
||||
which provides file-level access to a firmware volume. The
|
||||
Firmware Volume Protocol abstracts the file system that is
|
||||
used to format the firmware volume and the hardware
|
||||
device-hardening features that may be present.
|
||||
**/
|
||||
///
|
||||
/// The Firmware Volume Block Protocol is the low-level interface
|
||||
/// to a firmware volume. File-level access to a firmware volume
|
||||
/// should not be done using the Firmware Volume Block Protocol.
|
||||
/// Normal access to a firmware volume must use the Firmware
|
||||
/// Volume Protocol. Typically, only the file system driver that
|
||||
/// produces the Firmware Volume Protocol will bind to the
|
||||
/// Firmware Volume Block Protocol.
|
||||
///
|
||||
struct _EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL {
|
||||
EFI_FVB_GET_ATTRIBUTES GetAttributes;
|
||||
EFI_FVB_SET_ATTRIBUTES SetAttributes;
|
||||
|
Reference in New Issue
Block a user