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 68d721d1b1a689da29f8235e081e5ea1cfab054e..050d80fa738622e078896758b188456468e0b7ad 100644 (file)
--- a/MdePkg/Include/Pi/PiFirmwareVolume.h
+++ b/MdePkg/Include/Pi/PiFirmwareVolume.h
@@ -20,9 +20,9 @@
 \r
 #include <ProcessorBind.h>\r
 \r
-//\r
-// EFI_FV_FILE_ATTRIBUTES\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
@@ -116,20 +119,26 @@ typedef struct {
 ///\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