Use doxygen comment style for document entity such as struct, enum, variable that...

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

diff --git a/MdePkg/Include/Protocol/SimpleNetwork.h b/MdePkg/Include/Protocol/SimpleNetwork.h
index 74c5163fbb9006940412d33a13e23f62e502c186..3766e98f972300f67aea464204782e41724b9856 100644 (file)
--- a/MdePkg/Include/Protocol/SimpleNetwork.h
+++ b/MdePkg/Include/Protocol/SimpleNetwork.h
@@ -30,72 +30,72 @@
 typedef struct _EFI_SIMPLE_NETWORK_PROTOCOL  EFI_SIMPLE_NETWORK_PROTOCOL;\r
 \r
 \r
-//\r
-// Protocol defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol defined in EFI1.1.\r
+/// \r
 typedef EFI_SIMPLE_NETWORK_PROTOCOL   EFI_SIMPLE_NETWORK;\r
 \r
-//\r
-// Simple Network Protocol data structures\r
-//\r
+///\r
+/// Simple Network Protocol data structures\r
+///\r
 typedef struct {\r
-  //\r
-  // Total number of frames received.  Includes frames with errors and\r
-  // dropped frames.\r
-  //\r
+  ///\r
+  /// Total number of frames received.  Includes frames with errors and\r
+  /// dropped frames.\r
+  ///\r
   UINT64  RxTotalFrames;\r
 \r
-  //\r
-  // Number of valid frames received and copied into receive buffers.\r
-  //\r
+  ///\r
+  /// Number of valid frames received and copied into receive buffers.\r
+  ///\r
   UINT64  RxGoodFrames;\r
 \r
-  //\r
-  // Number of frames below the minimum length for the media.\r
-  // This would be <64 for ethernet.\r
-  //\r
+  ///\r
+  /// Number of frames below the minimum length for the media.\r
+  /// This would be <64 for ethernet.\r
+  ///\r
   UINT64  RxUndersizeFrames;\r
 \r
-  //\r
-  // Number of frames longer than the maxminum length for the\r
-  // media.  This would be >1500 for ethernet.\r
-  //\r
+  ///\r
+  /// Number of frames longer than the maxminum length for the\r
+  /// media.  This would be >1500 for ethernet.\r
+  ///\r
   UINT64  RxOversizeFrames;\r
 \r
-  //\r
-  // Valid frames that were dropped because receive buffers were full.\r
-  //\r
+  ///\r
+  /// Valid frames that were dropped because receive buffers were full.\r
+  ///\r
   UINT64  RxDroppedFrames;\r
 \r
-  //\r
-  // Number of valid unicast frames received and not dropped.\r
-  //\r
+  ///\r
+  /// Number of valid unicast frames received and not dropped.\r
+  ///\r
   UINT64  RxUnicastFrames;\r
 \r
-  //\r
-  // Number of valid broadcast frames received and not dropped.\r
-  //\r
+  ///\r
+  /// Number of valid broadcast frames received and not dropped.\r
+  ///\r
   UINT64  RxBroadcastFrames;\r
 \r
-  //\r
-  // Number of valid mutlicast frames received and not dropped.\r
-  //\r
+  ///\r
+  /// Number of valid mutlicast frames received and not dropped.\r
+  ///\r
   UINT64  RxMulticastFrames;\r
 \r
-  //\r
-  // Number of frames w/ CRC or alignment errors.\r
-  //\r
+  ///\r
+  /// Number of frames w/ CRC or alignment errors.\r
+  ///\r
   UINT64  RxCrcErrorFrames;\r
 \r
-  //\r
-  // Total number of bytes received.  Includes frames with errors\r
-  // and dropped frames.\r
+  ///\r
+  /// Total number of bytes received.  Includes frames with errors\r
+  /// and dropped frames.\r
   //\r
   UINT64  RxTotalBytes;\r
 \r
-  //\r
-  // Transmit statistics.\r
-  //\r
+  ///\r
+  /// Transmit statistics.\r
+  ///\r
   UINT64  TxTotalFrames;\r
   UINT64  TxGoodFrames;\r
   UINT64  TxUndersizeFrames;\r
@@ -107,14 +107,14 @@ typedef struct {
   UINT64  TxCrcErrorFrames;\r
   UINT64  TxTotalBytes;\r
 \r
-  //\r
-  // Number of collisions detection on this subnet.\r
-  //\r
+  ///\r
+  /// Number of collisions detection on this subnet.\r
+  ///\r
   UINT64  Collisions;\r
 \r
-  //\r
-  // Number of frames destined for unsupported protocol.\r
-  //\r
+  ///\r
+  /// Number of frames destined for unsupported protocol.\r
+  ///\r
   UINT64  UnsupportedProtocol;\r
 \r
 } EFI_NETWORK_STATISTICS;\r