MdePkg/SimpleTextInEx.h: Fix comments alignment

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

diff --git a/MdePkg/Include/Protocol/SimpleTextInEx.h b/MdePkg/Include/Protocol/SimpleTextInEx.h
index 436ff37b14960b39ef98186de25a2e8961271620..ffc11c601e1304e3ee283d4675a4a633dc4bd571 100644 (file)
--- a/MdePkg/Include/Protocol/SimpleTextInEx.h
+++ b/MdePkg/Include/Protocol/SimpleTextInEx.h
@@ -5,7 +5,7 @@
   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 - 2012, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2006 - 2018, 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
@@ -190,13 +190,10 @@ typedef struct {
                   pressed.\r
 \r
 \r
-  @retval EFI_SUCCESS     The keystroke information was\r
-                          returned.\r
-\r
-  @retval EFI_NOT_READY   There was no keystroke data available.\r
-                          EFI_DEVICE_ERROR The keystroke\r
-                          information was not returned due to\r
-                          hardware errors.\r
+  @retval EFI_SUCCESS      The keystroke information was returned.\r
+  @retval EFI_NOT_READY    There was no keystroke data available.\r
+  @retval EFI_DEVICE_ERROR The keystroke information was not returned due to\r
+                           hardware errors.\r
 \r
 \r
 **/\r
@@ -251,18 +248,19 @@ EFI_STATUS
 \r
   @param KeyData                  A pointer to a buffer that is filled in with\r
                                   the keystroke information for the key that was\r
-                                  pressed.\r
+                                  pressed. If KeyData.Key, KeyData.KeyState.KeyToggleState\r
+                                  and KeyData.KeyState.KeyShiftState are 0, then any incomplete\r
+                                  keystroke will trigger a notification of the KeyNotificationFunction.\r
 \r
-  @param KeyNotificationFunction  Points to the function to be\r
-                                  called when the key sequence\r
-                                  is typed specified by KeyData.\r
+  @param KeyNotificationFunction  Points to the function to be called when the key sequence\r
+                                  is typed specified by KeyData. This notification function\r
+                                  should be called at <=TPL_CALLBACK.\r
 \r
 \r
   @param NotifyHandle             Points to the unique handle assigned to\r
                                   the registered notification.\r
 \r
-  @retval EFI_SUCCESS           The device state was set\r
-                                appropriately.\r
+  @retval EFI_SUCCESS           Key notify was registered successfully.\r
 \r
   @retval EFI_OUT_OF_RESOURCES  Unable to allocate necessary\r
                                 data structures.\r
@@ -286,7 +284,7 @@ EFI_STATUS
   @param NotificationHandle The handle of the notification\r
                             function being unregistered.\r
 \r
-  @retval EFI_SUCCESS The device state was set appropriately.\r
+  @retval EFI_SUCCESS           Key notify was unregistered successfully.\r
 \r
   @retval EFI_INVALID_PARAMETER The NotificationHandle is\r
                                 invalid.\r