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 2369b85ec6f75df4bda298d250c05a6d3db74163..44d640cc70e224948f3046e5f66224121e063caf 100644 (file)
--- a/MdePkg/Include/Protocol/SimplePointer.h
+++ b/MdePkg/Include/Protocol/SimplePointer.h
@@ -1,7 +1,7 @@
 /** @file\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 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
@@ -28,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
@@ -83,30 +118,23 @@ EFI_STATUS
   IN OUT EFI_SIMPLE_POINTER_STATE         *State\r
   );\r
 \r
-/**  \r
-  @par Protocol Description:\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
-  @param Reset\r
-  Resets the pointer device. \r
-\r
-  @param GetState\r
-  Retrieves the current state of the pointer device. \r
-\r
-  @param WaitForInput\r
-  Event to use with WaitForEvent() to wait for input from the pointer device.\r
-\r
-  @param Mode\r
-  Pointer to EFI_SIMPLE_POINTER_MODE data. \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