Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/AbsolutePointer.h b/MdePkg/Include/Protocol/AbsolutePointer.h
index 2d1d48316d36c681c6907d72c8de688fcfb44ca8..ca7ca6c820fc412f602c0041834bf3203c46b93f 100644 (file)
--- a/MdePkg/Include/Protocol/AbsolutePointer.h
+++ b/MdePkg/Include/Protocol/AbsolutePointer.h
@@ -2,7 +2,7 @@
   The file provides services that allow information about a\r
   absolute pointer device to be retrieved.\r
   \r
-  Copyright (c) 2006 - 2007, 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
@@ -32,12 +32,7 @@ typedef struct _EFI_ABSOLUTE_POINTER_PROTOCOL EFI_ABSOLUTE_POINTER_PROTOCOL;
 /**\r
   The following data values in the EFI_ABSOLUTE_POINTER_MODE\r
   interface are read-only and are changed by using the appropriate\r
-  interface functions:\r
-  Attributes The following bits are set as needed (or'd\r
-  together) to indicate the capabilities of the device\r
-  supported. The remaining bits are undefined and should be\r
-  returned as 0.\r
-\r
+  interface functions.\r
   \r
   @param AbsoluteMinX The Absolute Minimum of the device on the\r
                       x-axis.\r
@@ -63,6 +58,10 @@ typedef struct _EFI_ABSOLUTE_POINTER_PROTOCOL EFI_ABSOLUTE_POINTER_PROTOCOL;
                       then the pointer device does not support a\r
                       zaxis. \r
 \r
+  @param Attributes   The following bits are set as needed (or'd\r
+                      together) to indicate the capabilities of the device\r
+                      supported. The remaining bits are undefined and should be 0.\r
+\r
 **/\r
 typedef struct {\r
   UINT64 AbsoluteMinX;\r
@@ -96,15 +95,15 @@ typedef struct {
   process is not defined by this specification and is left up to\r
   the platform firmware or driver to implement.\r
 \r
-  @param This A pointer to the EFI_ABSOLUTE_POINTER_PROTOCOL\r
-              instance.\r
+  @param This                 A pointer to the EFI_ABSOLUTE_POINTER_PROTOCOL\r
+                              instance.\r
 \r
   @param ExtendedVerification Indicates that the driver may\r
                               perform a more exhaustive\r
                               verification operation of the\r
                               device during reset.\r
 \r
-  @retval EFI_SUCCESS The device was reset.\r
+  @retval EFI_SUCCESS       The device was reset.\r
   \r
   @retval EFI_DEVICE_ERROR  The device is not functioning\r
                             correctly and could not be reset.\r
@@ -159,7 +158,7 @@ EFI_STATUS
                   support an z-axis, and this field must be\r
                   ignored.\r
 \r
-  @param ActiveButtons  Bits are set to 1 in this structure item\r
+  @param ActiveButtons Bits are set to 1 in this structure item\r
                        to indicate that device buttons are\r
                        active.\r
 \r
@@ -184,17 +183,17 @@ typedef struct {
   information, then EFI_DEVICE_ERROR is returned.\r
 \r
 \r
-  @param This A pointer to the EFI_ABSOLUTE_POINTER_PROTOCOL\r
-              instance.\r
+  @param This   A pointer to the EFI_ABSOLUTE_POINTER_PROTOCOL\r
+                instance.\r
 \r
   @param State  A pointer to the state information on the\r
                 pointer device.\r
 \r
-  @retval EFI_SUCCESS The state of the pointer device was\r
-                      returned in State.\r
+  @retval EFI_SUCCESS       The state of the pointer device was\r
+                            returned in State.\r
 \r
-  @retval EFI_NOT_READY The state of the pointer device has not\r
-                        changed since the last call to GetState().\r
+  @retval EFI_NOT_READY     The state of the pointer device has not\r
+                            changed since the last call to GetState().\r
 \r
   @retval EFI_DEVICE_ERROR  A device error occurred while\r
                             attempting to retrieve the pointer\r
@@ -204,12 +203,13 @@ 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
@@ -219,14 +219,14 @@ EFI_STATUS
   provided.\r
 \r
 \r
-  @param Reset  Resets the pointer device.\r
+  @param Reset        Resets the pointer device.\r
 \r
-  @param GetState Retrieves the current state of the pointer\r
-                  device.\r
+  @param GetState     Retrieves the current state of the pointer\r
+                      device.\r
 \r
   @param WaitForInput Event to use with WaitForEvent() to wait\r
                       for input from the pointer device.\r
-  @param Mode Pointer to EFI_ABSOLUTE_POINTER_MODE data.\r
+  @param Mode         Pointer to EFI_ABSOLUTE_POINTER_MODE data.\r
 \r
 **/\r
 struct _EFI_ABSOLUTE_POINTER_PROTOCOL {\r