Fix doxygen issue:

[mirror_edk2.git] / MdePkg / Include / Pi / PiFirmwareVolume.h

diff --git a/MdePkg/Include/Pi/PiFirmwareVolume.h b/MdePkg/Include/Pi/PiFirmwareVolume.h
index 9d5b81604dce51ebf7a8f0a6d5a5063bf3b5dda6..050d80fa738622e078896758b188456468e0b7ad 100644 (file)
--- a/MdePkg/Include/Pi/PiFirmwareVolume.h
+++ b/MdePkg/Include/Pi/PiFirmwareVolume.h
@@ -10,8 +10,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  PiFirmwareVolume.h\r
-\r
   @par Revision Reference:\r
   Version 1.0.\r
 \r
@@ -20,9 +18,11 @@
 #ifndef __PI_FIRMWAREVOLUME_H__\r
 #define __PI_FIRMWAREVOLUME_H__\r
 \r
-//\r
-// EFI_FV_FILE_ATTRIBUTES\r
-//\r
+#include <ProcessorBind.h>\r
+\r
+///\r
+/// EFI_FV_FILE_ATTRIBUTES\r
+///\r
 typedef UINT32  EFI_FV_FILE_ATTRIBUTES;\r
 \r
 //\r
@@ -32,6 +32,9 @@ typedef UINT32  EFI_FV_FILE_ATTRIBUTES;
 #define EFI_FV_FILE_ATTRIB_FIXED          0x00000100\r
 #define EFI_FV_FILE_ATTRIB_MEMORY_MAPPED  0x00000200\r
 \r
+///\r
+/// type of EFI FVB attribute\r
+/// \r
 typedef UINT32  EFI_FVB_ATTRIBUTES;\r
 \r
 // \r
@@ -92,9 +95,9 @@ typedef struct {
   UINT32 Length;\r
 } EFI_FV_BLOCK_MAP_ENTRY;\r
 \r
-//\r
-// Describes the features and layout of the firmware volume.\r
-//\r
+///\r
+/// Describes the features and layout of the firmware volume.\r
+///\r
 typedef struct {\r
   UINT8                     ZeroVector[16];\r
   EFI_GUID                  FileSystemGuid;\r
@@ -114,22 +117,28 @@ typedef struct {
 ///\r
 /// Firmware Volume Header Revision definition\r
 ///\r
-#define EFI_FVH_REVISION  0x01\r
+#define EFI_FVH_REVISION  0x02\r
 \r
-//\r
-// Extension header pointed by ExtHeaderOffset of volume header.\r
-// \r
+///\r
+/// Extension header pointed by ExtHeaderOffset of volume header.\r
+/// \r
 typedef struct {\r
   EFI_GUID  FvName;\r
   UINT32    ExtHeaderSize;\r
 } EFI_FIRMWARE_VOLUME_EXT_HEADER;\r
 \r
+///\r
+/// Entry struture for describing FV extension header\r
+/// \r
 typedef struct {\r
   UINT16    ExtEntrySize;\r
   UINT16    ExtEntryType;\r
 } EFI_FIRMWARE_VOLUME_EXT_ENTRY;\r
 \r
 #define EFI_FV_EXT_TYPE_OEM_TYPE  0x01\r
+///\r
+/// This extension header provides a mapping between a GUID and an OEM file type.\r
+/// \r
 typedef struct {\r
   EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;\r
   UINT32    TypeMask;\r