Correct the structure's comments to follow doxygen format.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / FirmwareVolume.h

diff --git a/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h b/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h
index 86bcc8c215f53910f58023ba2f146bfeeb7ed097..c2a7246ca28df7fb2098703ba280b406ebaf98e9 100644 (file)
--- 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\r
   attributes of the firmware volume.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -288,38 +288,45 @@ EFI_STATUS
 // Protocol interface structure\r
 //\r
 struct _EFI_FIRMWARE_VOLUME_PROTOCOL {\r
-///\r
-/// Retrieves volume capabilities and current settings.\r
-///\r
+  ///\r
+  /// Retrieves volume capabilities and current settings.\r
+  ///\r
   FRAMEWORK_EFI_FV_GET_ATTRIBUTES GetVolumeAttributes;\r
-///\r
-/// Modifies the current settings of the firmware volume.\r
-///\r
+\r
+  ///\r
+  /// Modifies the current settings of the firmware volume.\r
+  ///\r
   FRAMEWORK_EFI_FV_SET_ATTRIBUTES SetVolumeAttributes;\r
-///\r
-/// Reads an entire file from the firmware volume.\r
-///\r
+\r
+  ///\r
+  /// Reads an entire file from the firmware volume.\r
+  ///\r
   FRAMEWORK_EFI_FV_READ_FILE      ReadFile;\r
-///\r
-/// Reads a single section from a file into a buffer.\r
-///\r
+\r
+  ///\r
+  /// Reads a single section from a file into a buffer.\r
+  ///\r
   FRAMEWORK_EFI_FV_READ_SECTION   ReadSection;\r
-///\r
-/// Writes an entire file into the firmware volume.\r
-///\r
+\r
+  ///\r
+  /// Writes an entire file into the firmware volume.\r
+  ///\r
   FRAMEWORK_EFI_FV_WRITE_FILE     WriteFile;\r
-///\r
-/// Provides service to allow searching the firmware volume.\r
-///\r
+\r
+  ///\r
+  /// Provides service to allow searching the firmware volume.\r
+  ///\r
   FRAMEWORK_EFI_FV_GET_NEXT_FILE  GetNextFile;\r
-///\r
-///  Data field that indicates the size in bytes of the Key input buffer for\r
-///  the GetNextFile() API.\r
-///\r
-UINT32                KeySize;\r
-///\r
-///  Handle of the parent firmware volume.\r
-///\r
+\r
+  ///\r
+  ///  Data field that indicates the size in bytes of the Key input buffer for\r
+  ///  the GetNextFile() API.\r
+  ///\r
+  UINT32                KeySize;\r
+\r
+  ///\r
+  ///  Handle of the parent firmware volume.\r
+  ///\r
   EFI_HANDLE            ParentHandle;\r
 };\r
 \r