From 44717a398fddc4df1f4aeaa70bcd7a043187ed34 Mon Sep 17 00:00:00 2001 From: xli24 Date: Mon, 13 Oct 2008 02:54:29 +0000 Subject: 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 --- MdePkg/Include/Protocol/FirmwareVolume2.h | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) (limited to 'MdePkg/Include/Protocol/FirmwareVolume2.h') diff --git a/MdePkg/Include/Protocol/FirmwareVolume2.h b/MdePkg/Include/Protocol/FirmwareVolume2.h index 62218d7149..0d5e5481fb 100644 --- a/MdePkg/Include/Protocol/FirmwareVolume2.h +++ b/MdePkg/Include/Protocol/FirmwareVolume2.h @@ -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; -- cgit v1.2.3