summaryrefslogtreecommitdiff
path: root/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h
diff options
context:
space:
mode:
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2009-07-02 07:40:24 +0000
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2009-07-02 07:40:24 +0000
commit2bbaeb0d624f1d7758edd0a8d61322af209a1b1a (patch)
tree4e6161f7b624d87883fe7be6b53f4ff20203bb36 /IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h
parentd97286f4b36691776d0affe525387a9b56b6ba4f (diff)
downloadedk2-2bbaeb0d624f1d7758edd0a8d61322af209a1b1a.zip
edk2-2bbaeb0d624f1d7758edd0a8d61322af209a1b1a.tar.gz
edk2-2bbaeb0d624f1d7758edd0a8d61322af209a1b1a.tar.bz2
Correct the structure's comments to follow doxygen format.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8721 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h')
-rw-r--r--IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h61
1 files changed, 34 insertions, 27 deletions
diff --git a/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h b/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h
index 86bcc8c..c2a7246 100644
--- a/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h
+++ b/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h
@@ -7,7 +7,7 @@
Volume Protocol also provides mechanisms for determining and modifying some
attributes of the firmware volume.
- Copyright (c) 2007, Intel Corporation
+ Copyright (c) 2007 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -288,38 +288,45 @@ EFI_STATUS
// Protocol interface structure
//
struct _EFI_FIRMWARE_VOLUME_PROTOCOL {
-///
-/// Retrieves volume capabilities and current settings.
-///
+ ///
+ /// Retrieves volume capabilities and current settings.
+ ///
FRAMEWORK_EFI_FV_GET_ATTRIBUTES GetVolumeAttributes;
-///
-/// Modifies the current settings of the firmware volume.
-///
+
+ ///
+ /// Modifies the current settings of the firmware volume.
+ ///
FRAMEWORK_EFI_FV_SET_ATTRIBUTES SetVolumeAttributes;
-///
-/// Reads an entire file from the firmware volume.
-///
+
+ ///
+ /// Reads an entire file from the firmware volume.
+ ///
FRAMEWORK_EFI_FV_READ_FILE ReadFile;
-///
-/// Reads a single section from a file into a buffer.
-///
+
+ ///
+ /// Reads a single section from a file into a buffer.
+ ///
FRAMEWORK_EFI_FV_READ_SECTION ReadSection;
-///
-/// Writes an entire file into the firmware volume.
-///
+
+ ///
+ /// Writes an entire file into the firmware volume.
+ ///
FRAMEWORK_EFI_FV_WRITE_FILE WriteFile;
-///
-/// Provides service to allow searching the firmware volume.
-///
+
+ ///
+ /// Provides service to allow searching the firmware volume.
+ ///
FRAMEWORK_EFI_FV_GET_NEXT_FILE GetNextFile;
-///
-/// Data field that indicates the size in bytes of the Key input buffer for
-/// the GetNextFile() API.
-///
-UINT32 KeySize;
-///
-/// Handle of the parent firmware volume.
-///
+
+ ///
+ /// Data field that indicates the size in bytes of the Key input buffer for
+ /// the GetNextFile() API.
+ ///
+ UINT32 KeySize;
+
+ ///
+ /// Handle of the parent firmware volume.
+ ///
EFI_HANDLE ParentHandle;
};