Fix doxygen comment for structure and macro

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6096 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 44 insertions, 77 deletions

diff --git a/MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h b/MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h
index bb3b9a3905..64c2f7349e 100644
--- a/MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h
+++ b/MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h
@@ -47,92 +47,59 @@ typedef enum {
   @par Protocol Description:

   An optional protocol that is used to describe details about the software 

   layer that is used to produce the Simple Network Protocol. 

-

-  @param Revision

-  The revision of the EFI_NETWORK_INTERFACE_IDENTIFIER protocol.

-

-  @param Id

-  Address of the first byte of the identifying structure for this network 

-  interface. This is only valid when the network interface is started 

-  (see Start()). When the network interface is not started, this field is set to zero.

-

-  @param ImageAddr

-  Address of the unrelocated network interface image.

-

-  @param ImageSize

-  Size of unrelocated network interface image.

-

-  @param StringId

-  A four-character ASCII string that is sent in the class identifier field of

-  option 60 in DHCP. For a Type of EfiNetworkInterfaceUndi, this field is UNDI.

-

-  @param Type

-  Network interface type. This will be set to one of the values 

-  in EFI_NETWORK_INTERFACE_TYPE.

-

-  @param MajorVer

-  Major version number.

-

-  @param MinorVer

-  Minor version number.

-

-  @param Ipv6Supported

-  TRUE if the network interface supports IPv6; otherwise FALSE.

-

-  @param IfNum

-  The network interface number that is being identified by this Network 

-  Interface Identifier Protocol. This field must be less than or equal 

-  to the IFcnt field in the !PXE structure.

-

 **/

 struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL {

-

+  ///

+  /// The revision of the EFI_NETWORK_INTERFACE_IDENTIFIER protocol.

+  ///

   UINT64  Revision;

-  //

-  // Revision of the network interface identifier protocol interface.

-  //

+  

+  ///

+  /// Address of the first byte of the identifying structure for this network 

+  /// interface. This is only valid when the network interface is started 

+  /// (see Start()). When the network interface is not started, this field is set to zero.

+  ///

   UINT64  ID;

-  //

-  // Address of the first byte of the identifying structure for this

-  // network interface.  This is set to zero if there is no structure.

-  //

-  // For PXE/UNDI this is the first byte of the !PXE structure.

-  //

+  

+  ///

+  /// Address of the first byte of the identifying structure for this

+  /// network interface.  This is set to zero if there is no structure.

+  ///

+  /// For PXE/UNDI this is the first byte of the !PXE structure.

+  ///

   UINT64  ImageAddr;

-  //

-  // Address of the UNrelocated driver/ROM image.  This is set

-  // to zero if there is no driver/ROM image.

-  //

-  // For 16-bit UNDI, this is the first byte of the option ROM in

-  // upper memory.

-  //

-  // For 32/64-bit S/W UNDI, this is the first byte of the EFI ROM

-  // image.

-  //

-  // For H/W UNDI, this is set to zero.

-  //

+  

+  ///

+  /// Size of unrelocated network interface image.

+  ///

   UINT32  ImageSize;

-  //

-  // Size of the UNrelocated driver/ROM image of this network interface.

-  // This is set to zero if there is no driver/ROM image.

-  //

+  

+  ///

+  /// A four-character ASCII string that is sent in the class identifier field of

+  /// option 60 in DHCP. For a Type of EfiNetworkInterfaceUndi, this field is UNDI.

+  ///

   CHAR8   StringId[4];

-  //

-  // 4 char ASCII string to go in class identifier (option 60) in DHCP

-  // and Boot Server discover packets.

-  // For EfiNetworkInterfaceUndi this field is "UNDI".

-  // For EfiNetworkInterfaceSnp this field is "SNPN".

-  //

+  

+  ///

+  /// Network interface type. This will be set to one of the values 

+  /// in EFI_NETWORK_INTERFACE_TYPE.

+  ///

   UINT8   Type;

-  UINT8   MajorVer;

-  UINT8   MinorVer;

-  //

-  // Information to be placed into the PXE DHCP and Discover packets.

-  // This is the network interface type and version number that will

-  // be placed into DHCP option 94 (client network interface identifier).

-  //

+  

+  UINT8   MajorVer;     ///< Major version number.

+  UINT8   MinorVer;     ///< Minor version number.

+  

+  ///

+  /// TRUE if the network interface supports IPv6; otherwise FALSE.\

+  ///

   BOOLEAN Ipv6Supported;

-  UINT8   IfNum;  // interface number to be used with pxeid structure

+

+  ///

+  /// The network interface number that is being identified by this Network 

+  /// Interface Identifier Protocol. This field must be less than or equal 

+  /// to the IFcnt field in the !PXE structure.

+  ///

+  UINT8   IfNum;

 };

 

 extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid;