MdePkg/Include/Protocol/Tls.h: pack structures from the TLS RFC

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

diff --git a/MdePkg/Include/Protocol/AbsolutePointer.h b/MdePkg/Include/Protocol/AbsolutePointer.h
index 853ce33c9aec238ca6d4c644c1890381776f1182..a4efea221fc5696f5911c619d5f9ddc3ba78ca4e 100644 (file)
--- a/MdePkg/Include/Protocol/AbsolutePointer.h
+++ b/MdePkg/Include/Protocol/AbsolutePointer.h
@@ -1,9 +1,9 @@
 /** @file\r
-  The file provides services that allow information about a\r
+  The file provides services that allow information about an\r
   absolute pointer device to be retrieved.\r
   \r
-  Copyright (c) 2006 - 2008, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2012, 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
@@ -108,7 +108,7 @@ EFI_STATUS
 **/\r
 typedef struct {\r
   ///\r
-  /// The unsigned position of the activation on the x axis If the AboluteMinX \r
+  /// The unsigned position of the activation on the x axis. If the AboluteMinX \r
   /// and the AboluteMaxX fields of the EFI_ABSOLUTE_POINTER_MODE structure are \r
   /// both 0, then this pointer device does not support an x-axis, and this field\r
   /// must be ignored.\r
@@ -116,7 +116,7 @@ typedef struct {
   UINT64 CurrentX;\r
   \r
   ///\r
-  /// The unsigned position of the activation on the x axis If the AboluteMinY \r
+  /// The unsigned position of the activation on the y axis. If the AboluteMinY \r
   /// and the AboluteMaxY fields of the EFI_ABSOLUTE_POINTER_MODE structure are \r
   /// both 0, then this pointer device does not support an y-axis, and this field\r
   /// must be ignored.  \r
@@ -124,7 +124,7 @@ typedef struct {
   UINT64 CurrentY;\r
   \r
   ///\r
-  /// The unsigned position of the activation on the x axis, or the pressure \r
+  /// The unsigned position of the activation on the z axis, or the pressure \r
   /// measurement. If the AboluteMinZ and the AboluteMaxZ fields of the \r
   /// EFI_ABSOLUTE_POINTER_MODE structure are both 0, then this pointer device \r
   /// does not support an z-axis, and this field must be ignored.  \r
@@ -171,22 +171,19 @@ typedef struct {
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_ABSOLUTE_POINTER_GET_STATE)(\r
-  IN           EFI_ABSOLUTE_POINTER_PROTOCOL  *This,\r
-  IN OUT    EFI_ABSOLUTE_POINTER_STATE *State\r
+  IN      EFI_ABSOLUTE_POINTER_PROTOCOL  *This,\r
+  IN OUT  EFI_ABSOLUTE_POINTER_STATE     *State\r
 );\r
 \r
 \r
-/**\r
-  @par Protocol Description:\r
-  The EFI_ABSOLUTE_POINTER_PROTOCOL provides a set of services\r
-  for a pointer device that can be used as an input device from an\r
-  application written to this specification. The services include\r
-  the ability to reset the pointer device, retrieve the state of\r
-  the pointer device, and retrieve the capabilities of the pointer\r
-  device. In addition certain data items describing the device are\r
-  provided.\r
-\r
-**/\r
+///\r
+/// The EFI_ABSOLUTE_POINTER_PROTOCOL provides a set of services\r
+/// for a pointer device that can be used as an input device from an\r
+/// application written to this specification. The services include\r
+/// the ability to: reset the pointer device, retrieve the state of\r
+/// the pointer device, and retrieve the capabilities of the pointer\r
+/// device. The service also provides certain data items describing the device.\r
+///\r
 struct _EFI_ABSOLUTE_POINTER_PROTOCOL {\r
   EFI_ABSOLUTE_POINTER_RESET      Reset;\r
   EFI_ABSOLUTE_POINTER_GET_STATE  GetState;\r
@@ -194,6 +191,9 @@ struct _EFI_ABSOLUTE_POINTER_PROTOCOL {
   /// Event to use with WaitForEvent() to wait for input from the pointer device.  \r
   ///\r
   EFI_EVENT                       WaitForInput;\r
+  ///\r
+  /// Pointer to EFI_ABSOLUTE_POINTER_MODE data.\r
+  ///\r
   EFI_ABSOLUTE_POINTER_MODE       *Mode;\r
 };\r
 \r