Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/LoadedImage.h b/MdePkg/Include/Protocol/LoadedImage.h
index c9e5741fadd22cfc4e7225b24d656ccf34732779..f87011930b98cf31dcf43b44938c2f73e78b0af8 100644 (file)
--- a/MdePkg/Include/Protocol/LoadedImage.h
+++ b/MdePkg/Include/Protocol/LoadedImage.h
@@ -4,7 +4,7 @@
   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, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. 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
@@ -45,7 +45,53 @@
 // \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
+  @param Revision\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
+  @param ParentHandle\r
+  Parent image's image handle. NULL if the image is loaded directly from \r
+  the firmware's boot manager. \r
+\r
+  @param SystemTable\r
+  The image's EFI system table pointer. \r
+\r
+  @param DeviceHandle\r
+  The device handle that the EFI Image was loaded from. \r
+\r
+  @param FilePath\r
+  A pointer to the file path portion specific to DeviceHandle \r
+  that the EFI Image was loaded from. \r
+\r
+  @param Reserved\r
+  Reserved. DO NOT USE.\r
+\r
+  @param LoadOptionsSize\r
+  The size in bytes of LoadOptions.\r
+\r
+  @param LoadOptions\r
+  A pointer to the image's binary load options.\r
+\r
+  @param ImageBase\r
+  The base address at which the image was loaded.\r
+\r
+  @param ImageSize\r
+  The size in bytes of the loaded image.\r
+\r
+  @param ImageCodeType\r
+  The memory \r
+\r
+  @param ImageDataType\r
+  The memory \r
+\r
+  @param Unload\r
+  Function that unloads the image. \r
+\r
+**/\r
 typedef struct {\r
   UINT32                    Revision;\r
   EFI_HANDLE                ParentHandle;\r