Fix doxygen issue:

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

diff --git a/MdePkg/Include/Protocol/PxeBaseCode.h b/MdePkg/Include/Protocol/PxeBaseCode.h
index 7fb2a80c4233a10d46f179f5309079aa5aaeb5f0..e98a4976a7b3f9caa425eb4f8c33418b94077d33 100644 (file)
--- a/MdePkg/Include/Protocol/PxeBaseCode.h
+++ b/MdePkg/Include/Protocol/PxeBaseCode.h
@@ -10,8 +10,6 @@
   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:  PxeBaseCode.h\r
-\r
 **/\r
 #ifndef __PXE_BASE_CODE_PROTOCOL_H__\r
 #define __PXE_BASE_CODE_PROTOCOL_H__\r
@@ -24,7 +22,12 @@
     0x03c4e603, 0xac28, 0x11d3, {0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
   }\r
 \r
-typedef struct _EFI_PXE_BASE_CODE_PROTOCOL EFI_PXE_BASE_CODE_PROTOCOL;\r
+typedef struct _EFI_PXE_BASE_CODE_PROTOCOL  EFI_PXE_BASE_CODE_PROTOCOL;\r
+\r
+//\r
+// Protocol defined in EFI1.1.\r
+// \r
+typedef EFI_PXE_BASE_CODE_PROTOCOL  EFI_PXE_BASE_CODE;\r
 \r
 //\r
 // Default IP TTL and ToS.\r
@@ -246,7 +249,7 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PXE_BASE_CODE_START) (\r
+(EFIAPI *EFI_PXE_BASE_CODE_START)(\r
   IN EFI_PXE_BASE_CODE_PROTOCOL            *This,\r
   IN BOOLEAN                               UseIpv6\r
   );\r
@@ -265,7 +268,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PXE_BASE_CODE_STOP) (\r
+(EFIAPI *EFI_PXE_BASE_CODE_STOP)(\r
   IN EFI_PXE_BASE_CODE_PROTOCOL    *This\r
   );\r
 \r
@@ -291,7 +294,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PXE_BASE_CODE_DHCP) (\r
+(EFIAPI *EFI_PXE_BASE_CODE_DHCP)(\r
   IN EFI_PXE_BASE_CODE_PROTOCOL            *This,\r
   IN BOOLEAN                               SortOffers\r
   );\r
@@ -321,7 +324,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PXE_BASE_CODE_DISCOVER) (\r
+(EFIAPI *EFI_PXE_BASE_CODE_DISCOVER)(\r
   IN EFI_PXE_BASE_CODE_PROTOCOL           *This,\r
   IN UINT16                               Type,\r
   IN UINT16                               *Layer,\r
@@ -359,7 +362,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PXE_BASE_CODE_MTFTP) (\r
+(EFIAPI *EFI_PXE_BASE_CODE_MTFTP)(\r
   IN EFI_PXE_BASE_CODE_PROTOCOL                *This,\r
   IN EFI_PXE_BASE_CODE_TFTP_OPCODE             Operation,\r
   IN OUT VOID                                  *BufferPtr OPTIONAL,\r
@@ -400,7 +403,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PXE_BASE_CODE_UDP_WRITE) (\r
+(EFIAPI *EFI_PXE_BASE_CODE_UDP_WRITE)(\r
   IN EFI_PXE_BASE_CODE_PROTOCOL                *This,\r
   IN UINT16                                    OpFlags,\r
   IN EFI_IP_ADDRESS                            *DestIp,\r
@@ -442,7 +445,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PXE_BASE_CODE_UDP_READ) (\r
+(EFIAPI *EFI_PXE_BASE_CODE_UDP_READ)(\r
   IN EFI_PXE_BASE_CODE_PROTOCOL                *This,\r
   IN UINT16                                    OpFlags,\r
   IN OUT EFI_IP_ADDRESS                        *DestIp,     OPTIONAL\r
@@ -468,7 +471,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PXE_BASE_CODE_SET_IP_FILTER) (\r
+(EFIAPI *EFI_PXE_BASE_CODE_SET_IP_FILTER)(\r
   IN EFI_PXE_BASE_CODE_PROTOCOL            *This,\r
   IN EFI_PXE_BASE_CODE_IP_FILTER           *NewFilter\r
   );\r
@@ -491,7 +494,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PXE_BASE_CODE_ARP) (\r
+(EFIAPI *EFI_PXE_BASE_CODE_ARP)(\r
   IN EFI_PXE_BASE_CODE_PROTOCOL            *This,\r
   IN EFI_IP_ADDRESS                        *IpAddr,\r
   IN EFI_MAC_ADDRESS                       *MacAddr OPTIONAL\r
@@ -519,7 +522,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PXE_BASE_CODE_SET_PARAMETERS) (\r
+(EFIAPI *EFI_PXE_BASE_CODE_SET_PARAMETERS)(\r
   IN EFI_PXE_BASE_CODE_PROTOCOL            *This,\r
   IN BOOLEAN                               *NewAutoArp,     OPTIONAL\r
   IN BOOLEAN                               *NewSendGUID,    OPTIONAL\r
@@ -542,7 +545,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PXE_BASE_CODE_SET_STATION_IP) (\r
+(EFIAPI *EFI_PXE_BASE_CODE_SET_STATION_IP)(\r
   IN EFI_PXE_BASE_CODE_PROTOCOL            *This,\r
   IN EFI_IP_ADDRESS                        *NewStationIp,   OPTIONAL\r
   IN EFI_IP_ADDRESS                        *NewSubnetMask   OPTIONAL\r
@@ -578,7 +581,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PXE_BASE_CODE_SET_PACKETS) (\r
+(EFIAPI *EFI_PXE_BASE_CODE_SET_PACKETS)(\r
   IN EFI_PXE_BASE_CODE_PROTOCOL            *This,\r
   BOOLEAN                                  *NewDhcpDiscoverValid,   OPTIONAL\r
   BOOLEAN                                  *NewDhcpAckReceived,     OPTIONAL\r
@@ -597,8 +600,12 @@ EFI_STATUS
 //\r
 // PXE Base Code Protocol structure\r
 //\r
-#define EFI_PXE_BASE_CODE_INTERFACE_REVISION  0x00010000\r
-#define EFI_PXE_BASE_CODE_PROTOCOL_REVISION   EFI_PXE_BASE_CODE_INTERFACE_REVISION\r
+#define EFI_PXE_BASE_CODE_PROTOCOL_REVISION   0x00010000\r
+\r
+//\r
+// Revision defined in EFI1.1\r
+// \r
+#define EFI_PXE_BASE_CODE_INTERFACE_REVISION  EFI_PXE_BASE_CODE_PROTOCOL_REVISION\r
 \r
 struct _EFI_PXE_BASE_CODE_PROTOCOL {\r
   UINT64                            Revision;\r