Formalize comments for Protocols and PPIs.

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

diff --git a/MdePkg/Include/Protocol/SimpleTextIn.h b/MdePkg/Include/Protocol/SimpleTextIn.h
index 30905072cc5dc7c40d44e36f74d35b25be89671b..0716b736742cfdf2c1b6b472ed6c6ac47535057d 100644 (file)
--- a/MdePkg/Include/Protocol/SimpleTextIn.h
+++ b/MdePkg/Include/Protocol/SimpleTextIn.h
@@ -118,25 +118,16 @@ EFI_STATUS
   OUT EFI_INPUT_KEY                       *Key\r
   );\r
 \r
-/**  \r
-  @par Protocol Description:\r
-  The EFI_SIMPLE_TEXT_INPUT_PROTOCOL is used on the ConsoleIn device. \r
-  It is the minimum required protocol for ConsoleIn.\r
-\r
-  @param Reset\r
-  Reset the ConsoleIn device.\r
-\r
-  @param ReadKeyStroke\r
-  Returns the next input character.\r
-\r
-  @param WaitForKey\r
-  Event to use with WaitForEvent() to wait for a key to be available.\r
-\r
-**/\r
-\r
+///\r
+/// The EFI_SIMPLE_TEXT_INPUT_PROTOCOL is used on the ConsoleIn device. \r
+/// It is the minimum required protocol for ConsoleIn.\r
+///\r
 struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL {\r
   EFI_INPUT_RESET     Reset;\r
   EFI_INPUT_READ_KEY  ReadKeyStroke;\r
+  ///\r
+  /// Event to use with WaitForEvent() to wait for a key to be available\r
+  ///\r
   EFI_EVENT           WaitForKey;\r
 };\r
 \r