Code have been checked with spec

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

diff --git a/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h b/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
index 0745d7c655c30ec7c0d79018fdcccb76fa9aeeea..26b1503582cc23652a5df08a2febb09370fa58a0 100644 (file)
--- a/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
+++ b/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
@@ -17,31 +17,38 @@
 #ifndef _PXE_BASE_CODE_CALLBACK_H_\r
 #define _PXE_BASE_CODE_CALLBACK_H_\r
 \r
-//\r
-// Call Back Definitions\r
-//\r
+///\r
+/// Call Back Definitions\r
+///\r
 #define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_GUID \\r
   { \\r
     0x245dca21, 0xfb7b, 0x11d3, {0x8f, 0x01, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
   }\r
 \r
-//\r
-// Revision Number\r
-//\r
+///\r
+/// UEFI Revision Number Definition\r
+///\r
 #define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION 0x00010000\r
+\r
+///\r
+/// EFI 1.1 Revision Number defintion\r
+///\r
 #define EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION  \\r
         EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION\r
 \r
-//\r
-// Protocol definition\r
-//\r
+///\r
+/// UEFI Protocol name\r
+///\r
 typedef struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL  EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL;\r
 \r
-//\r
-// Protocol defined in EFI1.1.\r
-// \r
+///\r
+/// EFI1.1 Protocol name\r
+/// \r
 typedef EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL   EFI_PXE_BASE_CODE_CALLBACK;\r
 \r
+///\r
+/// Event type list for PXE Base Code Protocol function\r
+///\r
 typedef enum {\r
   EFI_PXE_BASE_CODE_FUNCTION_FIRST,\r
   EFI_PXE_BASE_CODE_FUNCTION_DHCP,\r
@@ -54,6 +61,9 @@ typedef enum {
   EFI_PXE_BASE_CODE_PXE_FUNCTION_LAST\r
 } EFI_PXE_BASE_CODE_FUNCTION;\r
 \r
+///\r
+/// Callback status type\r
+///\r
 typedef enum {\r
   EFI_PXE_BASE_CODE_CALLBACK_STATUS_FIRST,\r
   EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,\r
@@ -88,22 +98,16 @@ EFI_PXE_BASE_CODE_CALLBACK_STATUS
   IN EFI_PXE_BASE_CODE_PACKET             *Packet     OPTIONAL\r
   );\r
 \r
-/**  \r
-  @par Protocol Description:\r
-  Protocol that is invoked when the PXE Base Code Protocol is about \r
-  to transmit, has received, or is waiting to receive a packet.\r
-\r
-  @param Revision\r
-  The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must \r
-  be backwards compatible. If a future version is not backwards compatible \r
-  it is not the same GUID.\r
-\r
-  @param Callback\r
-  Callback routine used by the PXE Base Code Dhcp(), Discover(), Mtftp(), \r
-  UdpWrite(), and Arp() functions.\r
-\r
-**/\r
+///\r
+/// Protocol that is invoked when the PXE Base Code Protocol is about \r
+/// to transmit, has received, or is waiting to receive a packet.\r
+///\r
 struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL {\r
+  ///\r
+  ///  The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must \r
+  ///  be backwards compatible. If a future version is not backwards compatible \r
+  ///  it is not the same GUID.\r
+  ///\r
   UINT64            Revision;\r
   EFI_PXE_CALLBACK  Callback;\r
 };\r