Update the copyright notice format

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

diff --git a/MdePkg/Include/Protocol/SimpleTextIn.h b/MdePkg/Include/Protocol/SimpleTextIn.h
index 292339a651ff30a3da1fded85fc397c1c93ce4e7..b7026b5b4a17f3a3f58938999a18927c18966dbf 100644 (file)
--- a/MdePkg/Include/Protocol/SimpleTextIn.h
+++ b/MdePkg/Include/Protocol/SimpleTextIn.h
@@ -1,11 +1,11 @@
 /** @file\r
-  Simple Text In protocol from the UEFI 2.0 specification.\r
+  Simple Text Input protocol from the UEFI 2.0 specification.\r
 \r
   Abstraction of a very simple input device like a keyboard or serial\r
   terminal.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \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
@@ -18,27 +18,26 @@
 #ifndef __SIMPLE_TEXT_IN_PROTOCOL_H__\r
 #define __SIMPLE_TEXT_IN_PROTOCOL_H__\r
 \r
-#include <ProcessorBind.h>\r
-\r
 #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \\r
   { \\r
     0x387477c1, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
   }\r
 \r
-//\r
-// Protocol GUID defined in EFI1.1.\r
-// \r
-#define SIMPLE_INPUT_PROTOCOL   EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID\r
-\r
 typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL  EFI_SIMPLE_TEXT_INPUT_PROTOCOL;\r
 \r
-//\r
-// Backward-compatible with EFI1.1.\r
-// \r
+///\r
+/// Protocol GUID name defined in EFI1.1.\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
 typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL  SIMPLE_INPUT_INTERFACE;\r
-//\r
-// Data structures\r
-//\r
+\r
+///\r
+/// The keystroke information for the key that was pressed.\r
+///\r
 typedef struct {\r
   UINT16  ScanCode;\r
   CHAR16  UnicodeChar;\r
@@ -82,7 +81,7 @@ typedef struct {
 #define SCAN_ESC        0x0017\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
@@ -96,19 +95,18 @@ EFI_STATUS
 (EFIAPI *EFI_INPUT_RESET)(\r
   IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL       *This,\r
   IN BOOLEAN                              ExtendedVerification\r
-  )\r
-;\r
+  );\r
 \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  Key  Driver may perform diagnostics on reset.\r
 \r
   @retval EFI_SUCCESS      The keystroke information was returned.\r
-  @retval EFI_NOT_READY    There was no keystroke data availiable.\r
-  @retval EFI_DEVICE_ERROR The keydtroke information was not returned due to\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
@@ -117,28 +115,18 @@ EFI_STATUS
 (EFIAPI *EFI_INPUT_READ_KEY)(\r
   IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL       *This,\r
   OUT EFI_INPUT_KEY                       *Key\r
-  )\r
-;\r
-\r
-/**  \r
-  @par Protocol Description:\r
-  The EFI_SIMPLE_TEXT_INPUT_PROTOCOL is used on the ConsoleIn device. \r
-  It is the minimum required protocol for ConsoleIn.\r
-\r
-  @param Reset\r
-  Reset the ConsoleIn device.\r
-\r
-  @param ReadKeyStroke\r
-  Returns the next input character.\r
-\r
-  @param WaitForKey\r
-  Event to use with WaitForEvent() to wait for a key to be available.\r
-\r
-**/\r
+  );\r
 \r
+///\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
   EFI_INPUT_RESET     Reset;\r
   EFI_INPUT_READ_KEY  ReadKeyStroke;\r
+  ///\r
+  /// Event to use with WaitForEvent() to wait for a key to be available\r
+  ///\r
   EFI_EVENT           WaitForKey;\r
 };\r
 \r