Committing changes to the comments, to improve code documentation.

[mirror_edk2.git] / MdeModulePkg / Include / Guid / MemoryTypeInformation.h

diff --git a/MdeModulePkg/Include/Guid/MemoryTypeInformation.h b/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
index 02794cab7369f9b3a4bc414ae164752b0d9ef151..f2c0ae3fcdc298d81f01a1b21dca867c1b1ef34c 100644 (file)
--- a/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
+++ b/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
@@ -1,5 +1,7 @@
 /** @file\r
-  GUID used for Memory Type Information entries in the HOB list.\r
+  This file defines the memory type information GUID for its variable and guid. \r
+  It also defines memory type info variable name and data structure for both variable and hob,\r
+  which can be used to store the information for each memory type in EFI variable or HOB.\r
 \r
 Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
@@ -23,8 +25,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 extern EFI_GUID gEfiMemoryTypeInformationGuid;\r
 \r
 typedef struct {\r
-  UINT32  Type;\r
-  UINT32  NumberOfPages;\r
+  UINT32  Type;             ///> EFI memory type defined in UEFI specification.\r
+  UINT32  NumberOfPages;    ///> The pages of this type memory.\r
 } EFI_MEMORY_TYPE_INFORMATION;\r
 \r
 #endif\r