Formalize comments for Protocols and PPIs.

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

diff --git a/MdePkg/Include/Protocol/SimpleTextInEx.h b/MdePkg/Include/Protocol/SimpleTextInEx.h
index 3092fcbdd0952e476a4c81c66cb09ef6d13554a5..8dcb5e141906eb80d306f293a7113ad76223aee4 100644 (file)
--- a/MdePkg/Include/Protocol/SimpleTextInEx.h
+++ b/MdePkg/Include/Protocol/SimpleTextInEx.h
@@ -300,34 +300,18 @@ EFI_STATUS
 );\r
 \r
 \r
-/**\r
-  The EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL is used on the ConsoleIn\r
-  device. It is an extension to the Simple Text Input protocol\r
-  which allows a variety of extended shift state information to be\r
-  returned.\r
-\r
-  @param Reset            \r
-  Reset the ConsoleIn device. See Reset().\r
-\r
-  @param ReadKeyStrokeEx  \r
-  Returns the next input character.\r
-\r
-  @param WaitForKeyEx   \r
-  Event to use with WaitForEvent() to wait for a key to be available.\r
-\r
-  @param SetState   \r
-  Set the EFI_KEY_TOGGLE_STATE state settings for the input device.\r
-\r
-  @param RegisterKeyNotify  \r
-  Register a notification function to be called when a given key sequence is hit.\r
-\r
-  @param UnregisterKeyNotifyRemoves   \r
-  A specific notification function.\r
-\r
-**/\r
+///\r
+/// The EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL is used on the ConsoleIn\r
+/// device. It is an extension to the Simple Text Input protocol\r
+/// which allows a variety of extended shift state information to be\r
+/// returned.\r
+///\r
 struct _EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL{\r
   EFI_INPUT_RESET_EX              Reset;\r
   EFI_INPUT_READ_KEY_EX           ReadKeyStrokeEx;\r
+  ///\r
+  /// Event to use with WaitForEvent() to wait for a key to be available.\r
+  ///\r
   EFI_EVENT                       WaitForKeyEx;\r
   EFI_SET_STATE                   SetState;\r
   EFI_REGISTER_KEYSTROKE_NOTIFY   RegisterKeyNotify;\r