update codes per MdePkg doxgen review comments.

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

diff --git a/MdePkg/Include/Protocol/SimpleTextInEx.h b/MdePkg/Include/Protocol/SimpleTextInEx.h
index df5e6fd393842490658a25ddac98d72250b0234b..5baede162ffb6d9810f337ba459a36e18c24e546 100644 (file)
--- a/MdePkg/Include/Protocol/SimpleTextInEx.h
+++ b/MdePkg/Include/Protocol/SimpleTextInEx.h
@@ -1,8 +1,9 @@
 /** @file\r
-  The file defines the protocol to obtain input from the\r
-  ConsoleIn device. The EFI specification requires that the\r
-  EFI_SIMPLE_TEXT_INPUT_PROTOCOL supports the same languages as\r
-  the corresponding\r
+  Simple Text Input Ex protocol from the UEFI 2.0 specification.\r
+  \r
+  This protocol defines an extension to the EFI_SIMPLE_TEXT_INPUT_PROTOCOL\r
+  which exposes much more state and modifier information from the input device,\r
+  also allows one to register a notification for a particular keystroke.\r
 \r
   Copyright (c) 2006 - 2009, Intel Corporation \r
   All rights reserved. This program and the accompanying materials                          \r
@@ -150,27 +151,28 @@ typedef struct {
   EFI_NOT_READY. If there is a pending keystroke, then\r
   KeyData.Key.ScanCode is the EFI scan code defined in Error!\r
   Reference source not found. The KeyData.Key.UnicodeChar is the\r
-  actual printable character, or is zero if the key does not\r
+  actual printable character or is zero if the key does not\r
   represent a printable character (control key, function key,\r
   etc.). The KeyData.KeyState is shift state for the character\r
   reflected in KeyData.Key.UnicodeChar or KeyData.Key.ScanCode .\r
-  When interpreting the data from this function, printable characters that are\r
+  When interpreting the data from this function, it should be\r
+  noted that if a class of printable characters that are\r
   normally adjusted by shift modifiers (e.g. Shift Key + "f"\r
-  key) are presented solely as a KeyData.Key.UnicodeChar\r
-  without the associated shift state. For example,\r
-  if Shift Key + "f" key are pressed, the only pertinent\r
+  key) would be presented solely as a KeyData.Key.UnicodeChar\r
+  without the associated shift state. So in the previous example\r
+  of a Shift Key + "f" key being pressed, the only pertinent\r
   data returned would be KeyData.Key.UnicodeChar with the value\r
-  of "F". This would not typically be the case for\r
-  non-printable characters such as pressing the Right\r
-  Shift Key + F10 key, since the corresponding returned data\r
+  of "F". This of course would not typically be the case for\r
+  non-printable characters such as the pressing of the Right\r
+  Shift Key + F10 key since the corresponding returned data\r
   would be reflected both in the KeyData.KeyState.KeyShiftState\r
   and KeyData.Key.ScanCode values. UEFI drivers which implement\r
   the EFI_SIMPLE_TEXT_INPUT_EX protocol are required to return\r
   KeyData.Key and KeyData.KeyState values. These drivers must\r
   always return the most current state of\r
   KeyData.KeyState.KeyShiftState and\r
-  KeyData.KeyState.KeyToggleState. \r
-  Certain input devices may not be able to produce shift or toggle\r
+  KeyData.KeyState.KeyToggleState. It should also be noted that\r
+  certain input devices may not be able to produce shift or toggle\r
   state information, and in those cases the high order bit in the\r
   respective Toggle and Shift state fields should not be active.\r
 \r
@@ -237,7 +239,7 @@ EFI_STATUS
 \r
 /**\r
   The RegisterKeystrokeNotify() function registers a function\r
-  to be called when a specified keystroke will occur.\r
+  which will be called when a specified keystroke will occur.\r
   \r
   @param This                     A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
   \r
@@ -270,8 +272,8 @@ EFI_STATUS
 );\r
 \r
 /**\r
-  The UnregisterKeystrokeNotify() function removes a\r
-  notification that was previously registered.\r
+  The UnregisterKeystrokeNotify() function removes the\r
+  notification which was previously registered.\r
   \r
   @param This               A pointer to the EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL instance.\r
   \r