Formalize comments for Protocols and PPIs.

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

diff --git a/MdePkg/Include/Protocol/Bds.h b/MdePkg/Include/Protocol/Bds.h
index 8bcfa93fac9da72e4b53a0a9c9a9482cf7e46801..d9ef2fd8034664e69329b614fcded49108c9c380 100644 (file)
--- a/MdePkg/Include/Protocol/Bds.h
+++ b/MdePkg/Include/Protocol/Bds.h
@@ -17,15 +17,15 @@
 #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
@@ -55,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