Use doxygen comment style for document entity such as struct, enum, variable that...

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

diff --git a/MdePkg/Include/Protocol/LoadFile.h b/MdePkg/Include/Protocol/LoadFile.h
index 346039fb6150e8945d9e61966572e26115d225c6..c2867f49373f6a3a8c4a58d2eeec4aaeb8b7417b 100644 (file)
--- a/MdePkg/Include/Protocol/LoadFile.h
+++ b/MdePkg/Include/Protocol/LoadFile.h
@@ -1,13 +1,13 @@
 /** @file\r
-  Load File protocol as defined in the EFI 1.0 specification.\r
+  Load File protocol as defined in the UEFI 2.0 specification.\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
-  EFI 1.0 can boot from any device that produces a LoadFile protocol.\r
+  UEFI 2.0 can boot from any device that produces a LoadFile 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
@@ -16,25 +16,28 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  LoadFile.h\r
-\r
 **/\r
 \r
 #ifndef __EFI_LOAD_FILE_PROTOCOL_H__\r
 #define __EFI_LOAD_FILE_PROTOCOL_H__\r
 \r
-#define LOAD_FILE_PROTOCOL_GUID \\r
+#define EFI_LOAD_FILE_PROTOCOL_GUID \\r
   { \\r
     0x56EC3091, 0x954C, 0x11d2, {0x8E, 0x3F, 0x00, 0xA0, 0xC9, 0x69, 0x72, 0x3B } \\r
   }\r
 \r
 //\r
-// Protocol Guid Name defined by UEFI 2.0 spec.\r
+// Protocol Guid defined by EFI1.1.\r
 //\r
-#define EFI_LOAD_FILE_PROTOCOL_GUID LOAD_FILE_PROTOCOL_GUID\r
+#define LOAD_FILE_PROTOCOL EFI_LOAD_FILE_PROTOCOL_GUID\r
 \r
 typedef struct _EFI_LOAD_FILE_PROTOCOL EFI_LOAD_FILE_PROTOCOL;\r
 \r
+//\r
+// Backward-compatible with EFI1.1\r
+// \r
+typedef EFI_LOAD_FILE_PROTOCOL  EFI_LOAD_FILE_INTERFACE;\r
+\r
 /**\r
   Causes the driver to load a specified file.\r
 \r
@@ -65,7 +68,7 @@ typedef struct _EFI_LOAD_FILE_PROTOCOL EFI_LOAD_FILE_PROTOCOL;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_LOAD_FILE) (\r
+(EFIAPI *EFI_LOAD_FILE)(\r
   IN EFI_LOAD_FILE_PROTOCOL           *This,\r
   IN EFI_DEVICE_PATH_PROTOCOL         *FilePath,\r
   IN BOOLEAN                          BootPolicy,\r
@@ -74,6 +77,14 @@ EFI_STATUS
   )\r
 ;\r
 \r
+/**  \r
+  @par Protocol Description:\r
+  The EFI_LOAD_FILE_PROTOCOL is a simple protocol used to obtain files from arbitrary devices.\r
+ \r
+  @param LoadFile \r
+  Causes the driver to load the requested file.\r
+\r
+**/\r
 struct _EFI_LOAD_FILE_PROTOCOL {\r
   EFI_LOAD_FILE LoadFile;\r
 };\r