Reviewed the description in the FatBinPkg .dec file.

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

diff --git a/MdePkg/Include/Protocol/Bds.h b/MdePkg/Include/Protocol/Bds.h
index e8d0a5de1d7bcc33f6bec45310a8e59ac2b494a2..d9ef2fd8034664e69329b614fcded49108c9c380 100644 (file)
--- a/MdePkg/Include/Protocol/Bds.h
+++ b/MdePkg/Include/Protocol/Bds.h
@@ -1,9 +1,9 @@
 /** @file\r
-  Boot Device Selection Architectural Protocol as defined in DXE CIS\r
+  Boot Device Selection Architectural Protocol as defined in PI spec Volume 2 DXE\r
 \r
   When the DXE core is done it calls the BDS via this 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
@@ -12,23 +12,20 @@
   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
-  @par Revision Reference:\r
-  Version 0.91B.\r
-\r
 **/\r
 \r
 #ifndef __ARCH_PROTOCOL_BDS_H__\r
 #define __ARCH_PROTOCOL_BDS_H__\r
 \r
-//\r
-// Global ID for the BDS Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the BDS Architectural Protocol\r
+///\r
 #define EFI_BDS_ARCH_PROTOCOL_GUID \\r
   { 0x665E3FF6, 0x46CC, 0x11d4, {0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } }\r
 \r
-//\r
-// Declare forward reference for the BDS Architectural Protocol\r
-//\r
+///\r
+/// Declare forward reference for the BDS Architectural Protocol\r
+///\r
 typedef struct _EFI_BDS_ARCH_PROTOCOL   EFI_BDS_ARCH_PROTOCOL;\r
 \r
 /**\r
@@ -58,24 +55,14 @@ VOID
   IN EFI_BDS_ARCH_PROTOCOL  *This\r
   );\r
 \r
-/**\r
-  Interface stucture for the BDS Architectural Protocol.\r
-\r
-  @par Protocol Description:\r
-  The EFI_BDS_ARCH_PROTOCOL transfers control from DXE to an operating \r
-  system or a system utility.  If there are not enough drivers initialized \r
-  when this protocol is used to access the required boot device(s), then \r
-  this protocol should add drivers to the dispatch queue and return control \r
-  back to the dispatcher.  Once the required boot devices are available, then \r
-  the boot device can be used to load and invoke an OS or a system utility.\r
-\r
-  @par Protocol Parameters:\r
-  Entry - The entry point to BDS.  This call does not take any parameters, \r
-  and the return value can be ignored.  If it returns, then the \r
-  dispatcher must be invoked again, if it never returns, then an \r
-  operating system or a system utility have been invoked.\r
-\r
-**/\r
+///\r
+/// The EFI_BDS_ARCH_PROTOCOL transfers control from DXE to an operating \r
+/// system or a system utility.  If there are not enough drivers initialized \r
+/// when this protocol is used to access the required boot device(s), then \r
+/// this protocol should add drivers to the dispatch queue and return control \r
+/// back to the dispatcher.  Once the required boot devices are available, then \r
+/// the boot device can be used to load and invoke an OS or a system utility.\r
+///\r
 struct _EFI_BDS_ARCH_PROTOCOL {\r
   EFI_BDS_ENTRY Entry;\r
 };\r