Committing changes to the comments, to improve code documentation.

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / LoadPe32Image.h

diff --git a/MdeModulePkg/Include/Protocol/LoadPe32Image.h b/MdeModulePkg/Include/Protocol/LoadPe32Image.h
index 8adfdfc2d2af6fa95824b400c4e7a60efa7b1d12..42876ad9382f5e3345bb7aee642270a994a2ff5a 100644 (file)
--- a/MdeModulePkg/Include/Protocol/LoadPe32Image.h
+++ b/MdeModulePkg/Include/Protocol/LoadPe32Image.h
@@ -1,13 +1,7 @@
 /** @file\r
 \r
-  Load File protocol provides capability to load and unload EFI image into \r
-  memory and execute it.\r
-\r
-  Load file protocol exists to supports the addition of new boot devices,\r
-  and to support booting from devices that do not map well to file system.\r
-  Network boot is done via a LoadFile protocol.\r
-\r
-  UEFI 2.0 can boot from any device that produces a LoadFile protocol.\r
+  Load Pe32 Image protocol enables loading and unloading EFI images into memory and executing those images.\r
+  This protocol uses File Device Path to get EFI image.\r
 \r
 Copyright (c) 2006 - 2008, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
@@ -36,7 +30,7 @@ typedef struct _EFI_PE32_IMAGE_PROTOCOL   EFI_PE32_IMAGE_PROTOCOL;
 \r
   Loads an EFI image into memory and returns a handle to the image with extended parameters.\r
 \r
-  @param  This                Calling context\r
+  @param  This                Pointer to the LoadPe32Image protocol instance\r
   @param  ParentImageHandle   The caller's image handle.\r
   @param  FilePath            The specific file path from which the image is loaded.\r
   @param  SourceBuffer        If not NULL, a pointer to the memory location containing a copy of\r
@@ -54,7 +48,7 @@ typedef struct _EFI_PE32_IMAGE_PROTOCOL   EFI_PE32_IMAGE_PROTOCOL;
   @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
   @retval EFI_UNSUPPORTED       The image type is not supported, or the device path cannot be\r
                                 parsed to locate the proper protocol for loading the file.\r
-  @retval EFI_OUT_OF_RESOURCES  Image was not loaded due to insufficient resources.\r
+  @retval EFI_OUT_OF_RESOURCES  Image was not loaded due to insufficient memory resources.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -75,12 +69,12 @@ EFI_STATUS
 \r
   Unload the specified image.\r
 \r
-  @param  This             Indicates the calling context.\r
-  @param  ImageHandle      The specified image handle.\r
+  @param  This             Pointer to the LoadPe32Image protocol instance\r
+  @param  ImageHandle      The specified image handle to be unloaded.\r
 \r
   @retval EFI_INVALID_PARAMETER Image handle is NULL.\r
   @retval EFI_UNSUPPORTED       Attempt to unload an unsupported image.\r
-  @retval EFI_SUCCESS           Image successfully unloaded.\r
+  @retval EFI_SUCCESS           Image is successfully unloaded.\r
 \r
 --*/\r
 typedef\r
@@ -92,7 +86,7 @@ EFI_STATUS
 \r
 struct _EFI_PE32_IMAGE_PROTOCOL {\r
   LOAD_PE_IMAGE     LoadPeImage;\r
-  UNLOAD_PE_IMAGE  UnLoadPeImage;\r
+  UNLOAD_PE_IMAGE   UnLoadPeImage;\r
 };\r
 \r
 extern EFI_GUID gEfiLoadPeImageProtocolGuid;\r