MdePkg: Clean up source files

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

diff --git a/MdePkg/Include/Library/SerialPortLib.h b/MdePkg/Include/Library/SerialPortLib.h
index 965a2d964b02ffea5df0412c02db3c0b4bb8cc45..0c4ef58dd8e0e4defa137544f436a9f9f0f6b3d8 100644 (file)
--- a/MdePkg/Include/Library/SerialPortLib.h
+++ b/MdePkg/Include/Library/SerialPortLib.h
@@ -1,7 +1,7 @@
 /** @file\r
   This library class provides common serial I/O port functions.\r
 \r
 /** @file\r
   This library class provides common serial I/O port functions.\r
 \r

-Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r

 Copyright (c) 2012 - 2014, ARM Ltd. All rights reserved.\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 Copyright (c) 2012 - 2014, ARM Ltd. All rights reserved.\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r


@@ -21,11 +21,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 /**\r
   Initialize the serial device hardware.\r
 \r
 /**\r
   Initialize the serial device hardware.\r

-  \r
+\r

   If no initialization is required, 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
   If no initialization is required, 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
+\r

   @retval RETURN_SUCCESS        The serial device was initialized.\r
   @retval RETURN_DEVICE_ERROR   The serial device could not be initialized.\r
 \r
   @retval RETURN_SUCCESS        The serial device was initialized.\r
   @retval RETURN_DEVICE_ERROR   The serial device could not be initialized.\r
 \r


@@ -37,19 +37,19 @@ SerialPortInitialize (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Write data from buffer to serial device. \r
- \r
-  Writes NumberOfBytes data bytes from Buffer to the serial device.  \r
+  Write data from buffer to serial device.\r
+\r
+  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
   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

-  If Buffer is NULL, then ASSERT(). \r
+  If Buffer is NULL, then ASSERT().\r

   If NumberOfBytes is zero, then return 0.\r
 \r
   @param  Buffer           Pointer to the data buffer to be written.\r
   @param  NumberOfBytes    Number of bytes to written to the serial device.\r
 \r
   @retval 0                NumberOfBytes is 0.\r
   If NumberOfBytes is zero, then return 0.\r
 \r
   @param  Buffer           Pointer to the data buffer to be written.\r
   @param  NumberOfBytes    Number of bytes to written to the serial device.\r
 \r
   @retval 0                NumberOfBytes is 0.\r

-  @retval >0               The number of bytes written to the serial device.  \r
+  @retval >0               The number of bytes written to the serial device.\r

                            If this value is less than NumberOfBytes, then the write operation failed.\r
 \r
 **/\r
                            If this value is less than NumberOfBytes, then the write operation failed.\r
 \r
 **/\r


@@ -63,11 +63,11 @@ SerialPortWrite (
 \r
 /**\r
   Read data from serial device and save the datas in buffer.\r
 \r
 /**\r
   Read data from serial device and save the datas in buffer.\r

- \r
+\r

   Reads NumberOfBytes data bytes from a serial device into the buffer\r
   Reads NumberOfBytes data bytes from a serial device into the buffer\r

-  specified by Buffer. The number of bytes actually read is returned. \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
   If the return value is less than NumberOfBytes, then the rest operation failed.\r

-  If Buffer is NULL, then ASSERT(). \r
+  If Buffer is NULL, then ASSERT().\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
   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