Second set of changes based on a review of the code comments in the Include directory...

[mirror_edk2.git] / MdePkg / Include / Library / SerialPortLib.h

diff --git a/MdePkg/Include/Library/SerialPortLib.h b/MdePkg/Include/Library/SerialPortLib.h
index 1ab8e97adc5c30add67e21e03d56fefdfd20cceb..60d32122976b7ce8fc15af91bc235b5da8fc9c2e 100644 (file)
--- a/MdePkg/Include/Library/SerialPortLib.h
+++ b/MdePkg/Include/Library/SerialPortLib.h
@@ -1,5 +1,5 @@
 /** @file\r
-  Provides three common serial I/O port functions.\r
+  This library class provides common serial I/O port functions.\r
 \r
 Copyright (c) 2006 - 2008, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
@@ -19,11 +19,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   Initialize the serial device hardware.\r
   \r
   If no initialization is required, then return RETURN_SUCCESS.\r
-  If the serial device was successfuly initialized, then return RETURN_SUCCESS.\r
+  If the serial device was successfully initialized, then return RETURN_SUCCESS.\r
   If the serial device could not be initialized, then return RETURN_DEVICE_ERROR.\r
   \r
   @retval RETURN_SUCCESS        The serial device was initialized.\r
-  @retval RETURN_DEVICE_ERROR   The serail device could not be initialized.\r
+  @retval RETURN_DEVICE_ERROR   The serial device could not be initialized.\r
 \r
 **/\r
 RETURN_STATUS\r
@@ -38,9 +38,7 @@ SerialPortInitialize (
   Writes NumberOfBytes data bytes from Buffer to the serial device.  \r
   The number of bytes actually written to the serial device is returned.\r
   If the return value is less than NumberOfBytes, then the write operation failed.\r
-\r
   If Buffer is NULL, then ASSERT(). \r
-\r
   If NumberOfBytes is zero, then return 0.\r
 \r
   @param  Buffer           Pointer to the data buffer to be written.\r
@@ -54,8 +52,8 @@ SerialPortInitialize (
 UINTN\r
 EFIAPI\r
 SerialPortWrite (\r
-  IN UINT8        *Buffer,\r
-  IN UINTN        NumberOfBytes\r
+  IN UINT8     *Buffer,\r
+  IN UINTN     NumberOfBytes\r
   );\r
 \r
 \r
@@ -65,29 +63,27 @@ SerialPortWrite (
   Reads NumberOfBytes data bytes from a serial device into the buffer\r
   specified by Buffer. The number of bytes actually read is returned. \r
   If the return value is less than NumberOfBytes, then the rest operation failed.\r
-\r
   If Buffer is NULL, then ASSERT(). \r
-\r
   If NumberOfBytes is zero, then return 0.\r
 \r
   @param  Buffer           Pointer to the data buffer to store the data read from the serial device.\r
   @param  NumberOfBytes    Number of bytes which will be read.\r
 \r
-  @retval 0                Read data failed, No data is to be read.\r
-  @retval !0               Aactual number of bytes read from serial device.\r
+  @retval 0                Read data failed, no data is to be read.\r
+  @retval >0               Actual number of bytes read from serial device.\r
 \r
 **/\r
 UINTN\r
 EFIAPI\r
 SerialPortRead (\r
-  OUT UINT8    *Buffer,\r
-  IN  UINTN    NumberOfBytes\r
+  OUT UINT8   *Buffer,\r
+  IN  UINTN   NumberOfBytes\r
   );\r
 \r
 /**\r
   Polls a serial device to see if there is any data waiting to be read.\r
 \r
-  Polls aserial device to see if there is any data waiting to be read.\r
+  Polls a serial device to see if there is any data waiting to be read.\r
   If there is data waiting to be read from the serial device, then TRUE is returned.\r
   If there is no data waiting to be read from the serial device, then FALSE is returned.\r
 \r