summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--MdePkg/Include/Library/SerialPortLib.h12
-rw-r--r--MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c11
2 files changed, 12 insertions, 11 deletions
diff --git a/MdePkg/Include/Library/SerialPortLib.h b/MdePkg/Include/Library/SerialPortLib.h
index d6eb376ff6..19d6094140 100644
--- a/MdePkg/Include/Library/SerialPortLib.h
+++ b/MdePkg/Include/Library/SerialPortLib.h
@@ -85,14 +85,14 @@ SerialPortRead (
);
/**
- Poll the serial device to see if there is any data waiting.
+ Polls a serial device to see if there is any data waiting to be read.
- If there is data waiting to be read from the serial port, then return
- TRUE. If there is no data waiting to be read from the serial port, then
- return FALSE.
+ Polls aserial device to see if there is any data waiting to be read.
+ If there is data waiting to be read from the serial device, then TRUE is returned.
+ If there is no data waiting to be read from the serial device, then FALSE is returned.
- @retval TRUE Data is waiting to be read.
- @retval FALSE There is no data waiting to be read.
+ @retval TRUE Data is waiting to be read from the serial device.
+ @retval FALSE There is no data waiting to be read from the serial device.
**/
BOOLEAN
diff --git a/MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c b/MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c
index e6b3c63365..ff1d14baba 100644
--- a/MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c
+++ b/MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c
@@ -90,13 +90,14 @@ SerialPortRead (
}
/**
- Poll the serial device to see if there is any data waiting.
+ Polls a serial device to see if there is any data waiting to be read.
- If there is data waiting to be read from the serial port, then return
- TRUE. If there is no data waiting to be read from the serial port, then
- return FALSE.
+ Polls aserial device to see if there is any data waiting to be read.
+ If there is data waiting to be read from the serial device, then TRUE is returned.
+ If there is no data waiting to be read from the serial device, then FALSE is returned.
- @retval FALSE There is no data waiting to be read.
+ @retval TRUE Data is waiting to be read from the serial device.
+ @retval FALSE There is no data waiting to be read from the serial device.
**/
BOOLEAN