Formalize comments for Protocols and PPIs.

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

diff --git a/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h b/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
index 7f1670136707eba90293ef50ea2a35b7cf818d77..fb030b24bd827de5532c5018404b42ca8af34edf 100644 (file)
--- a/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
+++ b/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
@@ -1,7 +1,9 @@
 /** @file\r
-  EFI PXE Base Code CallBack Protocol\r
+  EFI PXE Base Code CallBack Protocol is as defined in UEFI specification.\r
+  It is invoked when the PXE Base Code Protocol is about to transmit, has received, \r
+  or is waiting to receive a packet.\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
@@ -10,16 +12,14 @@
   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:  PxeBaseCodeCallBack.h\r
-\r
 **/\r
 \r
 #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
@@ -28,15 +28,20 @@
 //\r
 // Revision Number\r
 //\r
-#define EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION 0x00010000\r
-#define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION  \\r
-        EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION\r
+#define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION 0x00010000\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
+/// Protocol definition\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
+typedef EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL   EFI_PXE_BASE_CODE_CALLBACK;\r
+\r
 typedef enum {\r
   EFI_PXE_BASE_CODE_FUNCTION_FIRST,\r
   EFI_PXE_BASE_CODE_FUNCTION_DHCP,\r
@@ -83,7 +88,16 @@ EFI_PXE_BASE_CODE_CALLBACK_STATUS
   IN EFI_PXE_BASE_CODE_PACKET             *Packet     OPTIONAL\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