Formalize comments for Protocols and PPIs.

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

diff --git a/MdePkg/Include/Protocol/LoadFile.h b/MdePkg/Include/Protocol/LoadFile.h
index 6207ce052f8b3eb8211ffd710164cadef725745f..1f057550b5021eb96fccc27470a9be4e9912cd06 100644 (file)
--- a/MdePkg/Include/Protocol/LoadFile.h
+++ b/MdePkg/Include/Protocol/LoadFile.h
@@ -7,7 +7,7 @@
 \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
@@ -26,16 +26,16 @@
     0x56EC3091, 0x954C, 0x11d2, {0x8E, 0x3F, 0x00, 0xA0, 0xC9, 0x69, 0x72, 0x3B } \\r
   }\r
 \r
-//\r
-// Protocol Guid defined by EFI1.1.\r
-//\r
+///\r
+/// Protocol Guid defined by EFI1.1.\r
+///\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
+///\r
+/// Backward-compatible with EFI1.1\r
+/// \r
 typedef EFI_LOAD_FILE_PROTOCOL  EFI_LOAD_FILE_INTERFACE;\r
 \r
 /**\r
@@ -74,9 +74,11 @@ EFI_STATUS
   IN BOOLEAN                          BootPolicy,\r
   IN OUT UINTN                        *BufferSize,\r
   IN VOID                             *Buffer OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
+///\r
+/// The EFI_LOAD_FILE_PROTOCOL is a simple protocol used to obtain files from arbitrary devices.\r
+///\r
 struct _EFI_LOAD_FILE_PROTOCOL {\r
   EFI_LOAD_FILE LoadFile;\r
 };\r