MdePkg: Fix some typing errors in the header files

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

diff --git a/MdePkg/Include/Protocol/LoadedImage.h b/MdePkg/Include/Protocol/LoadedImage.h
index 6af6ef76bd7e4c036eed94332d04084e911632e0..bad20ad16648eafc5f3cde1c13f32a5c29ddc00d 100644 (file)
--- a/MdePkg/Include/Protocol/LoadedImage.h
+++ b/MdePkg/Include/Protocol/LoadedImage.h
@@ -4,8 +4,8 @@
   Every EFI driver and application is passed an image handle when it is loaded.\r
   This image handle will contain a Loaded Image Protocol.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
   http://opensource.org/licenses/bsd-license.php                                            \r
@@ -18,8 +18,6 @@
 #ifndef __LOADED_IMAGE_PROTOCOL_H__\r
 #define __LOADED_IMAGE_PROTOCOL_H__\r
 \r
-#include <Protocol/DevicePath.h>\r
-\r
 #define EFI_LOADED_IMAGE_PROTOCOL_GUID \\r
   { \\r
     0x5B1B31A1, 0x9562, 0x11d2, {0x8E, 0x3F, 0x00, 0xA0, 0xC9, 0x69, 0x72, 0x3B } \\r
@@ -45,72 +43,38 @@
 /// \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
-  /// 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
-  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
-  EFI_MEMORY_TYPE           ImageCodeType;\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
+  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