Fix a typo

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

diff --git a/MdePkg/Include/Protocol/SimplePointer.h b/MdePkg/Include/Protocol/SimplePointer.h
index 1061ff0cf8752c1daceffebd97f0433be92dbb06..5d22bf6e4496b9ff7b979b587e066333c7c7ed95 100644 (file)
--- a/MdePkg/Include/Protocol/SimplePointer.h
+++ b/MdePkg/Include/Protocol/SimplePointer.h
@@ -1,9 +1,9 @@
 /** @file\r
-  Simple Pointer protocol from the EFI 1.1 specification.\r
+  Simple Pointer protocol from the UEFI 2.0 specification.\r
 \r
   Abstraction of a very simple pointer device like a mice or tracekballs.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. 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
@@ -57,7 +57,7 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SIMPLE_POINTER_RESET) (\r
+(EFIAPI *EFI_SIMPLE_POINTER_RESET)(\r
   IN EFI_SIMPLE_POINTER_PROTOCOL            *This,\r
   IN BOOLEAN                                ExtendedVerification\r
   );\r
@@ -78,15 +78,28 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SIMPLE_POINTER_GET_STATE) (\r
+(EFIAPI *EFI_SIMPLE_POINTER_GET_STATE)(\r
   IN EFI_SIMPLE_POINTER_PROTOCOL          *This,\r
   IN OUT EFI_SIMPLE_POINTER_STATE         *State\r
   );\r
 \r
+///\r
+/// The EFI_SIMPLE_POINTER_PROTOCOL provides a set of services for a pointer \r
+/// device that can use used as an input device from an application written \r
+/// to this specification. The services include the ability to reset the \r
+/// pointer device, retrieve get the state of the pointer device, and \r
+/// retrieve the capabilities of the pointer device.\r
+///\r
 struct _EFI_SIMPLE_POINTER_PROTOCOL {\r
   EFI_SIMPLE_POINTER_RESET      Reset;\r
   EFI_SIMPLE_POINTER_GET_STATE  GetState;\r
+  ///\r
+  /// Event to use with WaitForEvent() to wait for input from the pointer device.\r
+  ///\r
   EFI_EVENT                     WaitForInput;\r
+  ///\r
+  /// Pointer to EFI_SIMPLE_POINTER_MODE data.\r
+  ///\r
   EFI_SIMPLE_POINTER_MODE       *Mode;\r
 };\r
 \r