diff options
author | vanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-06-11 01:46:51 +0000 |
---|---|---|
committer | vanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-06-11 01:46:51 +0000 |
commit | f754f721bf10508ca15c5c9243caa39c765662cf (patch) | |
tree | a30263d31dbc5cbe0d472c1ae870702d19111892 /MdePkg/Include/Protocol/SerialIo.h | |
parent | 41f2ff0b85f3118238aeac8dfda3a657340519a5 (diff) | |
download | edk2-f754f721bf10508ca15c5c9243caa39c765662cf.tar.gz edk2-f754f721bf10508ca15c5c9243caa39c765662cf.tar.bz2 edk2-f754f721bf10508ca15c5c9243caa39c765662cf.zip |
update codes per MdePkg doxgen review comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8526 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Protocol/SerialIo.h')
-rw-r--r-- | MdePkg/Include/Protocol/SerialIo.h | 15 |
1 files changed, 5 insertions, 10 deletions
diff --git a/MdePkg/Include/Protocol/SerialIo.h b/MdePkg/Include/Protocol/SerialIo.h index 4fbfe027eb..aca2cac188 100644 --- a/MdePkg/Include/Protocol/SerialIo.h +++ b/MdePkg/Include/Protocol/SerialIo.h @@ -104,13 +104,8 @@ EFI_STATUS );
/**
- Sets the following attributes for a serial device:
- * baud rate
- * receive FIFO depth
- * transmit/receive time out
- * parity
- * data bits
- * stop bits
+ Sets the baud rate, receive FIFO depth, transmit/receice time out, parity,
+ data buts, and stop bits on a serial device.
@param This Protocol instance pointer.
@param BaudRate The requested baud rate. A BaudRate value of 0 will use the
@@ -208,7 +203,7 @@ EFI_STATUS @param This Protocol instance pointer.
@param BufferSize On input, the size of the Buffer. On output, the amount of
data returned in Buffer.
- @param Buffer The buffer to which to return the data.
+ @param Buffer The buffer to return the data into.
@retval EFI_SUCCESS The data was read.
@retval EFI_DEVICE_ERROR The device reported an error.
@@ -277,8 +272,8 @@ typedef struct { ///
/// The Serial I/O protocol is used to communicate with UART-style serial devices.
-/// These can be standard UART serial ports in PC-AT systems, or serial ports attached
-/// to a USB interface or any character-based I/O device.
+/// These can be standard UART serial ports in PC-AT systems, serial ports attached
+/// to a USB interface, or potentially any character-based I/O device.
///
struct _EFI_SERIAL_IO_PROTOCOL {
///
|