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, 21 insertions, 1 deletions

diff --git a/MdePkg/Include/Protocol/SimplePointer.h b/MdePkg/Include/Protocol/SimplePointer.h
index 94c4f2176d..2369b85ec6 100644
--- a/MdePkg/Include/Protocol/SimplePointer.h
+++ b/MdePkg/Include/Protocol/SimplePointer.h
@@ -3,7 +3,7 @@
 

   Abstraction of a very simple pointer device like a mice or tracekballs.

 

-  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        

@@ -83,6 +83,26 @@ EFI_STATUS
   IN OUT EFI_SIMPLE_POINTER_STATE         *State

   );

 

+/**  

+  @par Protocol Description:

+  The EFI_SIMPLE_POINTER_PROTOCOL provides a set of services for a pointer 

+  device that can use used as an input device from an application written 

+  to this specification. The services include the ability to reset the 

+  pointer device, retrieve get the state of the pointer device, and 

+  retrieve the capabilities of the pointer device.

+

+  @param Reset

+  Resets the pointer device. 

+

+  @param GetState

+  Retrieves the current state of the pointer device. 

+

+  @param WaitForInput

+  Event to use with WaitForEvent() to wait for input from the pointer device.

+

+  @param Mode

+  Pointer to EFI_SIMPLE_POINTER_MODE data. 

+**/

 struct _EFI_SIMPLE_POINTER_PROTOCOL {

   EFI_SIMPLE_POINTER_RESET      Reset;

   EFI_SIMPLE_POINTER_GET_STATE  GetState;