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

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

diff --git a/MdePkg/Include/Protocol/Bds.h b/MdePkg/Include/Protocol/Bds.h
index d060eb9f57e87b0d52e6cdf101da6c485d64a3fe..843c5e9445be5d30cfb2f7b500420775754765be 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,25 +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
-  Module Name:  Bds.h\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
@@ -56,7 +51,7 @@ typedef struct _EFI_BDS_ARCH_PROTOCOL   EFI_BDS_ARCH_PROTOCOL;
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_BDS_ENTRY) (\r
+(EFIAPI *EFI_BDS_ENTRY)(\r
   IN EFI_BDS_ARCH_PROTOCOL  *This\r
   );\r
 \r