Fix doxygen comment for structure and macro

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

diff --git a/MdePkg/Include/Protocol/SerialIo.h b/MdePkg/Include/Protocol/SerialIo.h
index 5c69f8996e273a0c0dfe007c92def65e53b95d70..f057cffea08d9b1764d98fd466c6f691cd5ddc59 100644 (file)
--- a/MdePkg/Include/Protocol/SerialIo.h
+++ b/MdePkg/Include/Protocol/SerialIo.h
@@ -271,39 +271,13 @@ typedef struct {
   The Serial I/O protocol is used to communicate with UART-style serial devices. \r
   These can be standard UART serial ports in PC-AT systems, serial ports attached \r
   to a USB interface, or potentially any character-based I/O device.\r
-\r
-  @param Revision\r
-  The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions \r
-  must be backwards compatible. If a future version is not back wards compatible, \r
-  it is not the same GUID.\r
-\r
-  @param Reset\r
-  Resets the hardware device.\r
-\r
-  @param SetAttributes\r
-  Sets communication parameters for a serial device. These include \r
-  the baud rate, receive FIFO depth, transmit/receive time out, parity, data bits, \r
-  and stop bit attributes.\r
-\r
-  @param SetControl\r
-  Sets the control bits on a serial device. These include Request to \r
-  Send and Data Terminal Ready.\r
-\r
-  @param GetControl\r
-  Reads the status of the control bits on a serial device. These include \r
-  Clear to Send, Data Set Ready, Ring Indicator, and Carrier Detect.\r
-\r
-  @param Write\r
-  Sends a buffer of characters to a serial device.\r
-\r
-  @param Read\r
-  Receives a buffer of characters from a serial device.\r
-\r
-  @param Mode\r
-  Pointer to SERIAL_IO_MODE data. \r
-  \r
 **/\r
 struct _EFI_SERIAL_IO_PROTOCOL {\r
+  ///\r
+  /// The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions \r
+  /// must be backwards compatible. If a future version is not back wards compatible, \r
+  /// it is not the same GUID.\r
+  ///\r
   UINT32                      Revision;\r
   EFI_SERIAL_RESET            Reset;\r
   EFI_SERIAL_SET_ATTRIBUTES   SetAttributes;\r