Use doxygen comment style for document entity such as struct, enum, variable that...

[mirror_edk2.git] / MdePkg / Include / Guid / FileInfo.h

diff --git a/MdePkg/Include/Guid/FileInfo.h b/MdePkg/Include/Guid/FileInfo.h
index 31c9c739515428b4bf3d05267f3ac3791ec636df..a9f64666f3712542aede8de14f95e9717b669d4c 100644 (file)
--- a/MdePkg/Include/Guid/FileInfo.h
+++ b/MdePkg/Include/Guid/FileInfo.h
@@ -37,13 +37,13 @@ typedef struct {
   CHAR16    FileName[1];\r
 } EFI_FILE_INFO;\r
 \r
-//\r
-// The FileName field of the EFI_FILE_INFO data structure is variable length.\r
-// Whenever code needs to know the size of the EFI_FILE_INFO data structure, it needs to\r
-// be the size of the data structure without the FileName field.  The following macro\r
-// computes this size correctly no matter how big the FileName array is declared.\r
-// This is required to make the EFI_FILE_INFO data structure ANSI compilant.\r
-//\r
+///\r
+/// The FileName field of the EFI_FILE_INFO data structure is variable length.\r
+/// Whenever code needs to know the size of the EFI_FILE_INFO data structure, it needs to\r
+/// be the size of the data structure without the FileName field.  The following macro\r
+/// computes this size correctly no matter how big the FileName array is declared.\r
+/// This is required to make the EFI_FILE_INFO data structure ANSI compilant.\r
+///\r
 #define SIZE_OF_EFI_FILE_INFO EFI_FIELD_OFFSET (EFI_FILE_INFO, FileName)\r
 \r
 extern EFI_GUID gEfiFileInfoGuid;\r