MdePkg: Add BluetoothAttribute.h and BluetoothLeConfig.h

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

diff --git a/MdePkg/Include/Protocol/SimplePointer.h b/MdePkg/Include/Protocol/SimplePointer.h
index 5d22bf6e4496b9ff7b979b587e066333c7c7ed95..5ea6c05b7c89bf0ad3ecfedfccb3623fd85e9e18 100644 (file)
--- a/MdePkg/Include/Protocol/SimplePointer.h
+++ b/MdePkg/Include/Protocol/SimplePointer.h
@@ -1,10 +1,10 @@
 /** @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
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  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
   http://opensource.org/licenses/bsd-license.php                                            \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