Fix doxygen comment for structure and macro

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6090 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Protocol/AbsolutePointer.h b/MdePkg/Include/Protocol/AbsolutePointer.h
index 2b8d94d49fbd5dee54e7013a5d6ded5bf67c1752..853ce33c9aec238ca6d4c644c1890381776f1182 100644 (file)
--- a/MdePkg/Include/Protocol/AbsolutePointer.h
+++ b/MdePkg/Include/Protocol/AbsolutePointer.h
@@ -33,44 +33,20 @@ typedef struct _EFI_ABSOLUTE_POINTER_PROTOCOL EFI_ABSOLUTE_POINTER_PROTOCOL;
   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
-  \r
-  @param AbsoluteMinX The Absolute Minimum of the device on the\r
-                      x-axis.\r
-\r
-  @param AbsoluteMinY The Absolute Minimum of the device on the\r
-                      y axis.\r
-\r
-  @param AbsoluteMinZ The Absolute Minimum of the device on the\r
-                      z-axis.\r
-\r
-  @param AbsoluteMaxX The Absolute Maximum of the device on the\r
-                      x-axis. If 0, and the AbsoluteMinX is 0,\r
-                      then the pointer device does not support a\r
-                      xaxis.\r
-\r
-  @param AbsoluteMaxY The Absolute Maximum of the device on the\r
-                      y -axis. If 0,, and the AbsoluteMinX is 0,\r
-                      then the pointer device does not support a\r
-                      yaxis.\r
-\r
-  @param AbsoluteMaxZ The Absolute Maximum of the device on the\r
-                      z-axis. If 0 , and the AbsoluteMinX is 0,\r
-                      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
-  UINT64 AbsoluteMinY;\r
-  UINT64 AbsoluteMinZ;\r
-  UINT64 AbsoluteMaxX;\r
-  UINT64 AbsoluteMaxY;\r
-  UINT64 AbsoluteMaxZ;\r
-  UINT32 Attributes;\r
+  UINT64 AbsoluteMinX; ///< The Absolute Minimum of the device on the x-axis\r
+  UINT64 AbsoluteMinY; ///< The Absolute Minimum of the device on the y axis.\r
+  UINT64 AbsoluteMinZ; ///< The Absolute Minimum of the device on the z-axis\r
+  UINT64 AbsoluteMaxX; ///< The Absolute Maximum of the device on the x-axis. If 0, and the \r
+                       ///< AbsoluteMinX is 0, then the pointer device does not support a xaxis\r
+  UINT64 AbsoluteMaxY; ///< The Absolute Maximum of the device on the y -axis. If 0, and the \r
+                       ///< AbsoluteMinX is 0, then the pointer device does not support a yaxis.\r
+  UINT64 AbsoluteMaxZ; ///< The Absolute Maximum of the device on the z-axis. If 0 , and the \r
+                       ///< AbsoluteMinX is 0, then the pointer device does not support a zaxis\r
+  UINT32 Attributes;   ///< The following bits are set as needed (or'd together) to indicate the \r
+                       ///< capabilities of the device supported. The remaining bits are undefined \r
+                       ///< and should be 0\r
 } EFI_ABSOLUTE_POINTER_MODE;\r
 \r
 ///\r
@@ -116,57 +92,49 @@ EFI_STATUS
   IN BOOLEAN                       ExtendedVerification\r
 );\r
 \r
+///\r
+/// This bit is set if the touch sensor is active.\r
+///\r
+#define EFI_ABSP_TouchActive  0x00000001 \r
 \r
-\r
-\r
-/**\r
-  Definitions of bits within ActiveButtons.\r
-  \r
-  @param EFI_ABSP_TouchActive This bit is set if the touch\r
-                              sensor is active.\r
-  \r
-  @param EFI_ABS_AltActive    This bit is set if the alt sensor,\r
-                              such as pen-side button, is\r
-                              active.\r
-**/\r
-#define EFI_ABSP_TouchActive  0x00000001\r
+///\r
+/// This bit is set if the alt sensor, such as pen-side button, is active\r
+/// \r
 #define EFI_ABS_AltActive     0x00000002\r
 \r
 \r
 /**\r
   Definition of EFI_ABSOLUTE_POINTER_STATE.\r
-  \r
-  @param CurrentX The unsigned position of the activation on the\r
-                  x axis If the AboluteMinX and the AboluteMaxX\r
-                  fields of the EFI_ABSOLUTE_POINTER_MODE\r
-                  structure are both 0, then this pointer device\r
-                  does not support an x-axis, and this field\r
-                  must be ignored.\r
-\r
-  @param CurrentY The unsigned position of the activation on the\r
-                  x axis If the AboluteMinY and the AboluteMaxY\r
-                  fields of the EFI_ABSOLUTE_POINTER_MODE\r
-                  structure are both 0, then this pointer device\r
-                  does not support an y-axis, and this field\r
-                  must be ignored.\r
-\r
-  @param CurrentZ The unsigned position of the activation on the\r
-                  x axis, or the pressure measurement. If the\r
-                  AboluteMinZ and the AboluteMaxZ fields of the\r
-                  EFI_ABSOLUTE_POINTER_MODE structure are\r
-                  both 0, then this pointer device does not\r
-                  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
-                       to indicate that device buttons are\r
-                       active.\r
-\r
 **/\r
 typedef struct {\r
+  ///\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
+  ///\r
   UINT64 CurrentX;\r
+  \r
+  ///\r
+  /// The unsigned position of the activation on the x 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
+  ///\r
   UINT64 CurrentY;\r
+  \r
+  ///\r
+  /// The unsigned position of the activation on the x 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
+  ///\r
   UINT64 CurrentZ;\r
+  \r
+  ///\r
+  /// Bits are set to 1 in this structure item to indicate that device buttons are\r
+  /// active.\r
+  ///\r
   UINT32 ActiveButtons;\r
 } EFI_ABSOLUTE_POINTER_STATE;\r
 \r
@@ -218,20 +186,13 @@ EFI_STATUS
   device. In addition certain data items describing the device are\r
   provided.\r
 \r
-\r
-  @param Reset        Resets the pointer device.\r
-\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
-\r
 **/\r
 struct _EFI_ABSOLUTE_POINTER_PROTOCOL {\r
   EFI_ABSOLUTE_POINTER_RESET      Reset;\r
   EFI_ABSOLUTE_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
   EFI_ABSOLUTE_POINTER_MODE       *Mode;\r
 };\r