Update comments for Protocol definitions to match UEFI spec.

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

diff --git a/MdePkg/Include/Protocol/Arp.h b/MdePkg/Include/Protocol/Arp.h
index 9527ad51af24fc710109b7a8af750cc14d157fbf..edf204ebe315cf0675fbe4f5aa331d58024b89ba 100644 (file)
--- a/MdePkg/Include/Protocol/Arp.h
+++ b/MdePkg/Include/Protocol/Arp.h
@@ -9,7 +9,6 @@
   The EFI ARP Protocol provides services to map IP network\r
   address to hardware address used by a data link protocol.\r
   \r
-  \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
@@ -37,19 +36,19 @@
 typedef struct _EFI_ARP_PROTOCOL EFI_ARP_PROTOCOL;\r
 \r
 typedef struct {\r
-UINT32                      Size;\r
-BOOLEAN                     DenyFlag;\r
-BOOLEAN                     StaticFlag;\r
-UINT16                      HwAddressType;\r
-UINT16                      SwAddressType;\r
-UINT8                       HwAddressLength;\r
-UINT8                       SwAddressLength;\r
+  UINT32                      Size;\r
+  BOOLEAN                     DenyFlag;\r
+  BOOLEAN                     StaticFlag;\r
+  UINT16                      HwAddressType;\r
+  UINT16                      SwAddressType;\r
+  UINT8                       HwAddressLength;\r
+  UINT8                       SwAddressLength;\r
 } EFI_ARP_FIND_DATA;\r
 \r
 typedef struct {\r
-  UINT16                    SwAddressType;      // Host byte order\r
+  UINT16                    SwAddressType;      ///< Host byte order\r
   UINT8                     SwAddressLength;\r
-  VOID                      *StationAddress;    // Network byte order\r
+  VOID                      *StationAddress;    ///< Network byte order\r
   UINT32                    EntryTimeOut;\r
   UINT32                    RetryCount;\r
   UINT32                    RetryTimeOut;\r
@@ -75,8 +74,7 @@ EFI_STATUS
 (EFIAPI *EFI_ARP_CONFIGURE)(\r
   IN EFI_ARP_PROTOCOL       *This,\r
   IN EFI_ARP_CONFIG_DATA    *ConfigData   OPTIONAL\r
-  )\r
-;  \r
+  );  \r
 \r
 /**\r
   Inserts an entry to the ARP cache.\r
@@ -115,8 +113,7 @@ EFI_STATUS
   IN VOID                   *TargetHwAddress  OPTIONAL,\r
   IN UINT32                 TimeoutValue,\r
   IN BOOLEAN                Overwrite\r
-  )\r
-;  \r
+  );  \r
 \r
 /**\r
   Locates one or more entries in the ARP cache.\r
@@ -152,8 +149,7 @@ EFI_STATUS
   OUT UINT32                *EntryCount       OPTIONAL,\r
   OUT EFI_ARP_FIND_DATA     **Entries         OPTIONAL,\r
   IN BOOLEAN                Refresh\r
-  )\r
-;  \r
+  );  \r
 \r
 \r
 /**\r
@@ -177,8 +173,7 @@ EFI_STATUS
   IN EFI_ARP_PROTOCOL       *This,\r
   IN BOOLEAN                BySwAddress,\r
   IN VOID                   *AddressBuffer   OPTIONAL\r
-  )\r
-;  \r
+  );  \r
 \r
 /**\r
   Removes all dynamic ARP cache entries that were added by this interface.\r
@@ -195,8 +190,7 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_ARP_FLUSH)(\r
   IN EFI_ARP_PROTOCOL       *This\r
-  )\r
-;  \r
+  );  \r
 \r
 /**\r
   Starts an ARP request session.\r
@@ -229,8 +223,7 @@ EFI_STATUS
   IN VOID                   *TargetSwAddress  OPTIONAL,\r
   IN EFI_EVENT              ResolvedEvent     OPTIONAL,\r
   OUT VOID                  *TargetHwAddress  \r
-  )\r
-;  \r
+  );  \r
 \r
 /**\r
   Cancels an ARP request session.\r
@@ -254,36 +247,12 @@ EFI_STATUS
   IN EFI_ARP_PROTOCOL       *This, \r
   IN VOID                   *TargetSwAddress  OPTIONAL,\r
   IN EFI_EVENT              ResolvedEvent     OPTIONAL\r
-  )\r
-;  \r
-\r
-/**\r
-  @par Protocol Description:\r
-  ARP is used to resolve local network protocol addresses into \r
-  network hardware addresses.\r
-\r
-  @param Configure\r
-  Adds a new station address (protocol type and network address) to the ARP cache.\r
-  \r
-  @param Add\r
-  Manually inserts an entry to the ARP cache for administrative purpose.\r
-\r
-  @param Find\r
-  Locates one or more entries in the ARP cache.\r
+  );  \r
 \r
-  @param Delete\r
-  Removes an entry from the ARP cache.\r
-  \r
-  @param Flush\r
-  Removes all dynamic ARP cache entries of a specified protocol type.\r
-  \r
-  @param Request\r
-  Starts an ARP request session.\r
-  \r
-  @param Cancel\r
-  Abort previous ARP request session.\r
-\r
-**/\r
+///\r
+/// ARP is used to resolve local network protocol addresses into \r
+/// network hardware addresses.\r
+///\r
 struct _EFI_ARP_PROTOCOL {\r
   EFI_ARP_CONFIGURE         Configure;\r
   EFI_ARP_ADD               Add;\r