added comments for some structures and apply for doxgen format

[mirror_edk2.git] / MdePkg / Include / IndustryStandard / PeImage.h

diff --git a/MdePkg/Include/IndustryStandard/PeImage.h b/MdePkg/Include/IndustryStandard/PeImage.h
index 310f16b8e34f3cace31e87da835b5ed0cf72c109..e47b227a417acb3029bfef8963c04ea3f5965548 100644 (file)
--- a/MdePkg/Include/IndustryStandard/PeImage.h
+++ b/MdePkg/Include/IndustryStandard/PeImage.h
@@ -255,8 +255,8 @@ typedef struct {
 \r
 ///\r
 /// @attention\r
-/// EFI_IMAGE_NT_HEADERS32 and EFI_IMAGE_HEADERS64 are for use ONLY\r
-/// by tools.  All proper EFI code MUST use EFI_IMAGE_NT_HEADERS ONLY!!!\r
+/// EFI_IMAGE_NT_HEADERS32 is for use ONLY by tools.\r
+/// All proper EFI code MUST use EFI_IMAGE_NT_HEADERS ONLY!!!\r
 ///\r
 typedef struct {\r
   UINT32                      Signature;\r
@@ -266,6 +266,11 @@ typedef struct {
 \r
 #define EFI_IMAGE_SIZEOF_NT_OPTIONAL32_HEADER sizeof (EFI_IMAGE_NT_HEADERS32)\r
 \r
+///\r
+/// @attention\r
+/// EFI_IMAGE_HEADERS64 is for use ONLY by tools.\r
+/// All proper EFI code MUST use EFI_IMAGE_NT_HEADERS ONLY!!!\r
+///\r
 typedef struct {\r
   UINT32                      Signature;\r
   EFI_IMAGE_FILE_HEADER       FileHeader;\r
@@ -346,7 +351,7 @@ typedef EFI_IMAGE_NT_HEADERS64    EFI_IMAGE_NT_HEADERS;
 #define EFI_IMAGE_SUBSYSTEM_POSIX_CUI   7\r
 \r
 ///\r
-/// Section header format.\r
+/// Length of ShortName.\r
 ///\r
 #define EFI_IMAGE_SIZEOF_SHORT_NAME 8\r
 \r