Fix doxygen comment for structure and macro

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

diff --git a/MdePkg/Include/Protocol/Arp.h b/MdePkg/Include/Protocol/Arp.h
index 21d815668907abe47ffe17c6a9f0be4bdd9acc27..efdd4c2f3402672319c39a3f8d1857df576455a2 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
@@ -254,28 +253,6 @@ EFI_STATUS
   @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
-  @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
 struct _EFI_ARP_PROTOCOL {\r
   EFI_ARP_CONFIGURE         Configure;\r