Code Scrub for Protocol and Ppi Definition

[mirror_edk2.git] / MdePkg / Include / Ppi / LoadFile.h

diff --git a/MdePkg/Include/Ppi/LoadFile.h b/MdePkg/Include/Ppi/LoadFile.h
index 35aa2dfc2b7babb880021fc4d86dff3f94afc413..96955f764a9019988fa83db2b06764e7372e8a56 100644 (file)
--- a/MdePkg/Include/Ppi/LoadFile.h
+++ b/MdePkg/Include/Ppi/LoadFile.h
@@ -1,7 +1,7 @@
 /** @file\r
   Load image file from fv to memory. \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
@@ -25,6 +25,8 @@
 typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI;\r
 \r
 /**\r
+  Loads a PEIM into memory for subsequent execution.\r
+\r
   This service is the single member function of EFI_LOAD_FILE_PPI. This service separates\r
   image loading and relocating from the PEI Foundation.\r
   \r
@@ -57,18 +59,16 @@ typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI;
   @retval EFI_OUT_OF_RESOURCES  There was not enough memory.\r
 \r
   @retval EFI_LOAD_ERROR      There was no supported image in\r
-                              the file EFI_INVALID_PARAMETER\r
-                              FileHandle was not a valid\r
-                              firmware file handle.\r
+                              the file.\r
   @retval EFI_INVALID_PARAMETER   EntryPoint was NULL.\r
-\r
+                              Or FileHandle was not a valid firmware file handle.\r
   @retval EFI_NOT_SUPPORTED   An image requires relocations or\r
                               is not memory mapped.\r
    \r
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_LOAD_FILE) (\r
+(EFIAPI *EFI_PEI_LOAD_FILE)(\r
   IN CONST  EFI_PEI_LOAD_FILE_PPI   *This,\r
   IN CONST  EFI_PEI_FILE_HANDLE     FileHandle,\r
   OUT       EFI_PHYSICAL_ADDRESS    *ImageAddress,\r
@@ -79,6 +79,7 @@ EFI_STATUS
 \r
 \r
 /**\r
+  @par Ppi Description:\r
   This PPI is a pointer to the Load File service.\r
   This service will be published by a PEIM. The PEI Foundation\r
   will use this service to launch the known PEI module images.\r