Update comments for Protocol definitions to match UEFI spec.

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

diff --git a/MdePkg/Include/Protocol/SimplePointer.h b/MdePkg/Include/Protocol/SimplePointer.h
index 2369b85ec6f75df4bda298d250c05a6d3db74163..5d22bf6e4496b9ff7b979b587e066333c7c7ed95 100644 (file)
--- a/MdePkg/Include/Protocol/SimplePointer.h
+++ b/MdePkg/Include/Protocol/SimplePointer.h
@@ -83,30 +83,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