Code scrub for the Debug library, PostCode library, Print library, and ExtractGuidedS...

[mirror_edk2.git] / MdePkg / Library / SerialPortLibNull / SerialPortLibNull.c

diff --git a/MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c b/MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c
index 78223fcbe00c89e00ba43e4f8314e745411be393..1fdc6586a5612ba9f5f5d7b37f17f2a088aaea22 100644 (file)
--- a/MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c
+++ b/MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c
@@ -1,7 +1,7 @@
 /** @file\r
-  Serial I/O Port library functions with no library constructor/destructor\r
+  Null Serial Port library instance with empty functions.\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
+  Copyright (c) 2006 - 2008, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -18,11 +18,10 @@
 \r
 #include <Library/SerialPortLib.h>\r
 \r
-/*\r
-\r
+/**\r
   Programmed hardware of Serial port.\r
 \r
-  @return    Always return EFI_UNSUPPORTED.\r
+  @return    Always return RETURN_UNSUPPORTED.\r
 \r
 **/\r
 RETURN_STATUS\r
@@ -40,8 +39,7 @@ SerialPortInitialize (
   @param  Buffer           Point of data buffer which need to be writed.\r
   @param  NumberOfBytes    Number of output bytes which are cached in Buffer.\r
 \r
-  @retval 0                Write data failed.\r
-  @retval !0               Actual number of bytes writed to serial device.\r
+  @retval 0                No data is to be written.\r
 \r
 **/\r
 UINTN\r
@@ -58,11 +56,11 @@ SerialPortWrite (
 /**\r
   Read data from serial device and save the datas in buffer.\r
 \r
-  @param  Buffer           Point of data buffer which need to be writed.\r
-  @param  NumberOfBytes    Number of output bytes which are cached in Buffer.\r
+  @param  Buffer           Point of data buffer, which contains the data \r
+                           returned from the serial device.\r
+  @param  NumberOfBytes    Number of bytes which will be read.\r
 \r
-  @retval 0                Read data failed.\r
-  @retval !0               Aactual number of bytes read from serial device.\r
+  @retval 0                No data is to be read.\r
 \r
 **/\r
 UINTN\r