Fix a typo

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

diff --git a/MdePkg/Include/Protocol/LoadedImage.h b/MdePkg/Include/Protocol/LoadedImage.h
index c31b27545ad5f4d7b576f5d6e2a3de8805e38904..9a2a94ab0bb4e471e1eb7f58590a9155d3749687 100644 (file)
--- a/MdePkg/Include/Protocol/LoadedImage.h
+++ b/MdePkg/Include/Protocol/LoadedImage.h
@@ -49,76 +49,34 @@
 /// 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
-  /// All future revisions will be backward compatible to the current revision.\r
-  ///\r
-  UINT32                    Revision;\r
-\r
-  ///\r
-  /// Parent image's image handle. NULL if the image is loaded directly from \r
-  /// 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
+  UINT32            Revision;       ///< Defines the revision of the EFI_LOADED_IMAGE_PROTOCOL structure. \r
+                                    ///< All future revisions will be backward compatible to the current revision.\r
+  EFI_HANDLE        ParentHandle;   ///< Parent image's image handle. NULL if the image is loaded directly from \r
+                                    ///< the firmware's boot manager. \r
+  EFI_SYSTEM_TABLE  *SystemTable;   ///< the image's EFI system table pointer.\r
 \r
   //\r
   // Source location of image\r
   //\r
-  ///\r
-  /// The device handle that the EFI Image was loaded from. \r
-  ///\r
-  EFI_HANDLE                DeviceHandle;\r
-  \r
-  ///\r
-  /// A pointer to the file path portion specific to DeviceHandle \r
-  /// that the EFI Image was loaded from. \r
-  ///\r
-  EFI_DEVICE_PATH_PROTOCOL  *FilePath;\r
-  VOID                      *Reserved;       ///< Reserved. DO NOT USE.\r
+  EFI_HANDLE        DeviceHandle;   ///< The device handle that the EFI Image was loaded from. \r
+  EFI_DEVICE_PATH_PROTOCOL  *FilePath;  ///< A pointer to the file path portion specific to DeviceHandle \r
+                                        ///< that the EFI Image was loaded from. \r
+  VOID              *Reserved;      ///< Reserved. DO NOT USE.\r
 \r
   //\r
   // Images load options\r
   //\r
-  ///\r
-  /// The size in bytes of LoadOptions.\r
-  ///\r
-  UINT32                    LoadOptionsSize;\r
-  \r
-  ///\r
-  /// A pointer to the image's binary load options.\r
-  ///\r
-  VOID                      *LoadOptions;\r
+  UINT32            LoadOptionsSize;///< The size in bytes of LoadOptions.\r
+  VOID              *LoadOptions;   ///< A pointer to the image's binary load options.\r
 \r
   //\r
   // Location of where image was loaded\r
   //\r
-  ///\r
-  /// The base address at which the image was loaded.\r
-  ///\r
-  VOID                      *ImageBase;\r
-  \r
-  ///\r
-  /// 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
-  EFI_IMAGE_UNLOAD          Unload;\r
-\r
+  VOID              *ImageBase;     ///< The base address at which the image was loaded.\r
+  UINT64            ImageSize;      ///< The size in bytes of the loaded image.\r
+  EFI_MEMORY_TYPE   ImageCodeType;  ///< The memory type that the code sections were loaded as.\r
+  EFI_MEMORY_TYPE   ImageDataType;  ///< The memory type that the data sections were loaded as.\r
+  EFI_IMAGE_UNLOAD  Unload;\r
 } EFI_LOADED_IMAGE_PROTOCOL;\r
 \r
 //\r