Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...

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

diff --git a/MdePkg/Include/Protocol/SimplePointer.h b/MdePkg/Include/Protocol/SimplePointer.h
index a0e080407445119fa8eb3e3f3df40e67d7725fec..44d640cc70e224948f3046e5f66224121e063caf 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
+  Abstraction of a very simple pointer device like a mouse or trackball.\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
@@ -12,8 +12,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  SimplePointer.h\r
-\r
 **/\r
 \r
 #ifndef __SIMPLE_POINTER_H__\r
@@ -30,18 +28,53 @@ typedef struct _EFI_SIMPLE_POINTER_PROTOCOL  EFI_SIMPLE_POINTER_PROTOCOL;
 // Data structures\r
 //\r
 typedef struct {\r
+  ///\r
+  /// The signed distance in counts that the pointer device has been moved along the x-axis.\r
+  ///\r
   INT32   RelativeMovementX;\r
+  ///\r
+  /// The signed distance in counts that the pointer device has been moved along the y-axis.\r
+  ///\r
   INT32   RelativeMovementY;\r
+  ///\r
+  /// The signed distance in counts that the pointer device has been moved along the z-axis.\r
+  ///\r
   INT32   RelativeMovementZ;\r
+  ///\r
+  /// If TRUE, then the left button of the pointer device is being\r
+  /// pressed. If FALSE, then the left button of the pointer device is not being pressed.\r
+  ///\r
   BOOLEAN LeftButton;\r
+  ///\r
+  /// If TRUE, then the right button of the pointer device is being\r
+  /// pressed. If FALSE, then the right button of the pointer device is not being pressed.\r
+  ///\r
   BOOLEAN RightButton;\r
 } EFI_SIMPLE_POINTER_STATE;\r
 \r
 typedef struct {\r
+  ///\r
+  /// The resolution of the pointer device on the x-axis in counts/mm.\r
+  /// If 0, then the pointer device does not support an x-axis.\r
+  ///\r
   UINT64  ResolutionX;\r
+  ///\r
+  /// The resolution of the pointer device on the y-axis in counts/mm.\r
+  /// If 0, then the pointer device does not support an x-axis.\r
+  ///\r
   UINT64  ResolutionY;\r
+  ///\r
+  /// The resolution of the pointer device on the z-axis in counts/mm.\r
+  /// If 0, then the pointer device does not support an x-axis.\r
+  ///\r
   UINT64  ResolutionZ;\r
+  ///\r
+  /// TRUE if a left button is present on the pointer device. Otherwise FALSE.\r
+  ///\r
   BOOLEAN LeftButton;\r
+  ///\r
+  /// TRUE if a right button is present on the pointer device. Otherwise FALSE.\r
+  ///\r
   BOOLEAN RightButton;\r
 } EFI_SIMPLE_POINTER_MODE;\r
 \r
@@ -59,7 +92,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
@@ -80,15 +113,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