EmbeddedPkg/VirtualKeyboard: Fix few typos

Fix few typos in the documentation.

Cc: Leif Lindholm <leif.lindholm@linaro.org>
Cc: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-4-philmd@redhat.com>

diff --git a/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c
index 750371a06723463eb70c7b9f412f6a4335b8c877..e9d0b72ee6c3fd5bc13556ab84c20162ae994f0f 100644 (file)
--- a/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c
+++ b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.c
@@ -437,7 +437,7 @@ VirtualKeyboardFreeNotifyList (
                               pressed.\r
 \r
   @retval TRUE                Key be pressed matches a registered key.\r
-  @retval FLASE               Match failed.\r
+  @retval FALSE               Match failed.\r
 \r
 **/\r
 BOOLEAN\r
@@ -476,7 +476,7 @@ IsKeyRegistered (
   Signal the event if there is key available\r
 \r
   @param Event    the event object\r
-  @param Context  waitting context\r
+  @param Context  waiting context\r
 \r
 **/\r
 VOID\r
@@ -580,7 +580,7 @@ VirtualKeyboardReset (
 }\r
 \r
 /**\r
-  Reset the input device and optionaly run diagnostics\r
+  Reset the input device and optionally run diagnostics\r
 \r
   @param  This                  Protocol instance pointer.\r
   @param  ExtendedVerification  Driver may perform diagnostics on reset.\r
@@ -621,7 +621,7 @@ VirtualKeyboardResetEx (
 \r
 /**\r
   Reads the next keystroke from the input device. The WaitForKey Event can\r
-  be used to test for existance of a keystroke via WaitForEvent () call.\r
+  be used to test for existence of a keystroke via WaitForEvent () call.\r
 \r
   @param  VirtualKeyboardPrivate   Virtualkeyboard driver private structure.\r
   @param  KeyData                  A pointer to a buffer that is filled in\r
@@ -629,7 +629,7 @@ VirtualKeyboardResetEx (
                                    that was pressed.\r
 \r
   @retval EFI_SUCCESS              The keystroke information was returned.\r
-  @retval EFI_NOT_READY            There was no keystroke data availiable.\r
+  @retval EFI_NOT_READY            There was no keystroke data available.\r
   @retval EFI_DEVICE_ERROR         The keystroke information was not returned\r
                                    due to hardware errors.\r
   @retval EFI_INVALID_PARAMETER    KeyData is NULL.\r
@@ -731,14 +731,14 @@ VirtualKeyboardReadKeyStroke (
 \r
 /**\r
   Reads the next keystroke from the input device. The WaitForKey Event can\r
-  be used to test for existance of a keystroke via WaitForEvent () call.\r
+  be used to test for existence of a keystroke via WaitForEvent () call.\r
 \r
   @param  This         Protocol instance pointer.\r
   @param  KeyData      A pointer to a buffer that is filled in with the\r
                        keystroke state data 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 availiable.\r
+  @retval  EFI_NOT_READY         There was no keystroke data available.\r
   @retval  EFI_DEVICE_ERROR      The keystroke information was not returned\r
                                  due to hardware errors.\r
   @retval  EFI_INVALID_PARAMETER KeyData is NULL.\r
@@ -808,7 +808,7 @@ VirtualKeyboardSetState (
 \r
   @retval EFI_SUCCESS             The notification function was registered\r
                                   successfully.\r
-  @retval EFI_OUT_OF_RESOURCES    Unable to allocate resources for necesssary\r
+  @retval EFI_OUT_OF_RESOURCES    Unable to allocate resources for necessary\r
                                   data structures.\r
   @retval EFI_INVALID_PARAMETER   KeyData or NotifyHandle is NULL.\r
 \r

diff --git a/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h
index 29bc7a06fb1694b5afee2b47ffb6058668a434c0..d77bfe0167cde3e06f3ecc682a76bbb5c4d5a9ef 100644 (file)
--- a/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h
+++ b/EmbeddedPkg/Drivers/VirtualKeyboardDxe/VirtualKeyboard.h
@@ -323,7 +323,7 @@ VirtualKeyboardReset (
   );\r
 \r
 /**\r
-  Reset the input device and optionaly run diagnostics\r
+  Reset the input device and optionally run diagnostics\r
 \r
   @param  This                  Protocol instance pointer.\r
   @param  ExtendedVerification  Driver may perform diagnostics on reset.\r
@@ -373,7 +373,7 @@ VirtualKeyboardSetState (
 \r
 \r
   @retval EFI_SUCCESS             The notification function was registered successfully.\r
-  @retval EFI_OUT_OF_RESOURCES    Unable to allocate resources for necesssary data structures.\r
+  @retval EFI_OUT_OF_RESOURCES    Unable to allocate resources for necessary data structures.\r
   @retval EFI_INVALID_PARAMETER   KeyData or NotifyHandle is NULL.\r
 \r
 **/\r
@@ -429,7 +429,7 @@ VirtualKeyboardFreeNotifyList (
                             state data for the key that was pressed.\r
 \r
   @retval TRUE              Key be pressed matches a registered key.\r
-  @retval FLASE             Match failed.\r
+  @retval FALSE             Match failed.\r
 \r
 **/\r
 BOOLEAN\r
@@ -441,7 +441,7 @@ IsKeyRegistered (
 /**\r
   Waiting on the keyboard event, if there's any key pressed by the user, signal the event\r
 \r
-  @param  Event       The event that be siganlled when any key has been stroked.\r
+  @param  Event       The event that be signalled when any key has been struck.\r
   @param  Context     Pointer of the protocol EFI_SIMPLE_TEXT_INPUT_PROTOCOL.\r
 \r
 **/\r
@@ -455,7 +455,7 @@ VirtualKeyboardWaitForKey (
 /**\r
   Waiting on the keyboard event, if there's any key pressed by the user, signal the event\r
 \r
-  @param  Event    The event that be siganlled when any key has been stroked.\r
+  @param  Event    The event that be signalled when any key has been struck.\r
   @param  Context  Pointer of the protocol EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL.\r
 \r
 **/\r
@@ -514,14 +514,14 @@ VirtualKeyboardReadKeyStroke (
 \r
 /**\r
   Reads the next keystroke from the input device. The WaitForKey Event can\r
-  be used to test for existance of a keystroke via WaitForEvent () call.\r
+  be used to test for existence of a keystroke via WaitForEvent () call.\r
 \r
   @param  This         Protocol instance pointer.\r
   @param  KeyData      A pointer to a buffer that is filled in with the keystroke\r
                        state data 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 availiable.\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
   @retval  EFI_INVALID_PARAMETER KeyData is NULL.\r