Fix doxygen issue:

1) comment for structure should be in doxygen format, such as /// , /**, /*!
2) comment for data field of structure should in doxygen format.
3) should not exist blank between ") (" when declaring a type of function point.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5363 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 15 insertions, 6 deletions

diff --git a/MdePkg/Include/Pi/PiFirmwareVolume.h b/MdePkg/Include/Pi/PiFirmwareVolume.h
index 68d721d1b1..050d80fa73 100644
--- a/MdePkg/Include/Pi/PiFirmwareVolume.h
+++ b/MdePkg/Include/Pi/PiFirmwareVolume.h
@@ -20,9 +20,9 @@
 

 #include <ProcessorBind.h>

 

-//

-// EFI_FV_FILE_ATTRIBUTES

-//

+///

+/// EFI_FV_FILE_ATTRIBUTES

+///

 typedef UINT32  EFI_FV_FILE_ATTRIBUTES;

 

 //

@@ -32,6 +32,9 @@ typedef UINT32  EFI_FV_FILE_ATTRIBUTES;
 #define EFI_FV_FILE_ATTRIB_FIXED          0x00000100

 #define EFI_FV_FILE_ATTRIB_MEMORY_MAPPED  0x00000200

 

+///

+/// type of EFI FVB attribute

+/// 

 typedef UINT32  EFI_FVB_ATTRIBUTES;

 

 // 

@@ -116,20 +119,26 @@ typedef struct {
 ///

 #define EFI_FVH_REVISION  0x02

 

-//

-// Extension header pointed by ExtHeaderOffset of volume header.

-// 

+///

+/// Extension header pointed by ExtHeaderOffset of volume header.

+/// 

 typedef struct {

   EFI_GUID  FvName;

   UINT32    ExtHeaderSize;

 } EFI_FIRMWARE_VOLUME_EXT_HEADER;

 

+///

+/// Entry struture for describing FV extension header

+/// 

 typedef struct {

   UINT16    ExtEntrySize;

   UINT16    ExtEntryType;

 } EFI_FIRMWARE_VOLUME_EXT_ENTRY;

 

 #define EFI_FV_EXT_TYPE_OEM_TYPE  0x01

+///

+/// This extension header provides a mapping between a GUID and an OEM file type.

+/// 

 typedef struct {

   EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;

   UINT32    TypeMask;