Fix a cut-n-paste error in the comment for the "read keystroke" function.

[mirror_edk2.git] / MdePkg / Include / Protocol / SimpleTextIn.h

diff --git a/MdePkg/Include/Protocol/SimpleTextIn.h b/MdePkg/Include/Protocol/SimpleTextIn.h
index b7026b5b4a17f3a3f58938999a18927c18966dbf..f29170c201f6ca716d2254f82c09e6f10007c677 100644 (file)
--- a/MdePkg/Include/Protocol/SimpleTextIn.h
+++ b/MdePkg/Include/Protocol/SimpleTextIn.h
@@ -5,13 +5,13 @@
   terminal.\r
 \r
   Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>\r
-  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
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  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
+  http://opensource.org/licenses/bsd-license.php\r
 \r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
 \r
@@ -27,12 +27,12 @@ typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL  EFI_SIMPLE_TEXT_INPUT_PROTOCOL;
 \r
 ///\r
 /// Protocol GUID name defined in EFI1.1.\r
-/// \r
+///\r
 #define SIMPLE_INPUT_PROTOCOL   EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID\r
 \r
 ///\r
 /// Protocol name in EFI1.1 for backward-compatible.\r
-/// \r
+///\r
 typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL  SIMPLE_INPUT_INTERFACE;\r
 \r
 ///\r
@@ -98,11 +98,12 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Reads the next keystroke from the input device. The WaitForKey Event can \r
+  Reads the next keystroke from the input device. The WaitForKey Event can\r
   be used to test for existence of a keystroke via WaitForEvent () call.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Key  Driver may perform diagnostics on reset.\r
+  @param  This  Protocol instance pointer.\r
+  @param  Key   A pointer to a buffer that is filled in with the keystroke\r
+                information for the key that was pressed.\r
 \r
   @retval EFI_SUCCESS      The keystroke information was returned.\r
   @retval EFI_NOT_READY    There was no keystroke data available.\r
@@ -118,7 +119,7 @@ EFI_STATUS
   );\r
 \r
 ///\r
-/// The EFI_SIMPLE_TEXT_INPUT_PROTOCOL is used on the ConsoleIn device. \r
+/// The EFI_SIMPLE_TEXT_INPUT_PROTOCOL is used on the ConsoleIn device.\r
 /// It is the minimum required protocol for ConsoleIn.\r
 ///\r
 struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL {\r