Formalize comments for Protocols and PPIs.

[mirror_edk2.git] / MdePkg / Include / Protocol / LoadedImage.h

diff --git a/MdePkg/Include/Protocol/LoadedImage.h b/MdePkg/Include/Protocol/LoadedImage.h
index 6af6ef76bd7e4c036eed94332d04084e911632e0..c31b27545ad5f4d7b576f5d6e2a3de8805e38904 100644 (file)
--- a/MdePkg/Include/Protocol/LoadedImage.h
+++ b/MdePkg/Include/Protocol/LoadedImage.h
@@ -45,10 +45,9 @@
 /// \r
 #define EFI_LOADED_IMAGE_INFORMATION_REVISION    EFI_LOADED_IMAGE_PROTOCOL_REVISION\r
 \r
-/**  \r
-  @par Protocol Description:\r
-  Can be used on any image handle to obtain information about the loaded image.\r
-**/\r
+///\r
+/// Can be used on any image handle to obtain information about the loaded image.\r
+///\r
 typedef struct {\r
   ///\r
   /// Defines the revision of the EFI_LOADED_IMAGE_PROTOCOL structure. \r
@@ -61,6 +60,10 @@ typedef struct {
   /// the firmware's boot manager. \r
   ///\r
   EFI_HANDLE                ParentHandle;\r
+\r
+  ///\r
+  /// the image's EFI system table pointer.\r
+  ///\r
   EFI_SYSTEM_TABLE          *SystemTable;\r
 \r
   //\r
@@ -103,12 +106,17 @@ typedef struct {
   /// The size in bytes of the loaded image.\r
   ///\r
   UINT64                    ImageSize;\r
+\r
+  ///\r
+  /// The memory type that the code sections were loaded as.\r
+  ///\r
   EFI_MEMORY_TYPE           ImageCodeType;\r
+\r
+  ///\r
+  /// The memory type that the data sections were loaded as.\r
+  ///\r
   EFI_MEMORY_TYPE           ImageDataType;\r
 \r
-  //\r
-  // If the driver image supports a dynamic unload request\r
-  //\r
   EFI_IMAGE_UNLOAD          Unload;\r
 \r
 } EFI_LOADED_IMAGE_PROTOCOL;\r