Code Scrub for Protocol and Ppi Definition

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5564 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 17 insertions, 1 deletions

diff --git a/MdePkg/Include/Protocol/SimpleTextIn.h b/MdePkg/Include/Protocol/SimpleTextIn.h
index 5298b23146..292339a651 100644
--- a/MdePkg/Include/Protocol/SimpleTextIn.h
+++ b/MdePkg/Include/Protocol/SimpleTextIn.h
@@ -4,7 +4,7 @@
   Abstraction of a very simple input device like a keyboard or serial

   terminal.

 

-  Copyright (c) 2006, Intel Corporation                                                         

+  Copyright (c) 2006 - 2008, Intel Corporation                                                         

   All rights reserved. This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

   which accompanies this distribution.  The full text of the license may be found at        

@@ -120,6 +120,22 @@ EFI_STATUS
   )

 ;

 

+/**  

+  @par Protocol Description:

+  The EFI_SIMPLE_TEXT_INPUT_PROTOCOL is used on the ConsoleIn device. 

+  It is the minimum required protocol for ConsoleIn.

+

+  @param Reset

+  Reset the ConsoleIn device.

+

+  @param ReadKeyStroke

+  Returns the next input character.

+

+  @param WaitForKey

+  Event to use with WaitForEvent() to wait for a key to be available.

+

+**/

+

 struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL {

   EFI_INPUT_RESET     Reset;

   EFI_INPUT_READ_KEY  ReadKeyStroke;