Fix doxygen issue:

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

diff --git a/MdePkg/Include/Protocol/SimpleTextOut.h b/MdePkg/Include/Protocol/SimpleTextOut.h
index b568865f18f23015308657556165d4c08446d902..8ed4598dfce6ad2f45e50aa23b4c9744278a93b1 100644 (file)
--- a/MdePkg/Include/Protocol/SimpleTextOut.h
+++ b/MdePkg/Include/Protocol/SimpleTextOut.h
@@ -1,5 +1,5 @@
 /** @file\r
-  Simple Text Out protocol from the EFI 1.0 specification.\r
+  Simple Text Out protocol from the UEFI 2.0 specification.\r
 \r
   Abstraction of a very simple text based output device like VGA text mode or\r
   a serial terminal. The Simple Text Out protocol instance can represent\r
@@ -15,22 +15,29 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  SimpleTextOut.h\r
-\r
 **/\r
 \r
 #ifndef __SIMPLE_TEXT_OUT_H__\r
 #define __SIMPLE_TEXT_OUT_H__\r
 \r
-#define EFI_SIMPLE_TEXT_OUT_PROTOCOL_GUID \\r
+#include <PiDxe.h>\r
+\r
+#define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \\r
   { \\r
     0x387477c2, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
   }\r
 \r
-#define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID  EFI_SIMPLE_TEXT_OUT_PROTOCOL_GUID\r
+//\r
+// Protocol GUID defined in EFI1.1.\r
+// \r
+#define SIMPLE_TEXT_OUTPUT_PROTOCOL   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID\r
 \r
-typedef struct _EFI_SIMPLE_TEXT_OUT_PROTOCOL EFI_SIMPLE_TEXT_OUT_PROTOCOL;\r
-typedef struct _EFI_SIMPLE_TEXT_OUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL;\r
+typedef struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL;\r
+\r
+//\r
+// Backward-compatible with EFI1.1.\r
+// \r
+typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   SIMPLE_TEXT_OUTPUT_INTERFACE;\r
 \r
 //\r
 // Define's for required EFI Unicode Box Draw characters\r
@@ -154,8 +161,8 @@ typedef struct _EFI_SIMPLE_TEXT_OUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_TEXT_RESET) (\r
-  IN EFI_SIMPLE_TEXT_OUT_PROTOCOL           *This,\r
+(EFIAPI *EFI_TEXT_RESET)(\r
+  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL           *This,\r
   IN BOOLEAN                                ExtendedVerification\r
   )\r
 ;\r
@@ -180,8 +187,8 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_TEXT_STRING) (\r
-  IN EFI_SIMPLE_TEXT_OUT_PROTOCOL           *This,\r
+(EFIAPI *EFI_TEXT_STRING)(\r
+  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
   IN CHAR16                                 *String\r
   )\r
 ;\r
@@ -202,8 +209,8 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_TEXT_TEST_STRING) (\r
-  IN EFI_SIMPLE_TEXT_OUT_PROTOCOL           *This,\r
+(EFIAPI *EFI_TEXT_TEST_STRING)(\r
+  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
   IN CHAR16                                 *String\r
   )\r
 ;\r
@@ -226,8 +233,8 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_TEXT_QUERY_MODE) (\r
-  IN EFI_SIMPLE_TEXT_OUT_PROTOCOL           *This,\r
+(EFIAPI *EFI_TEXT_QUERY_MODE)(\r
+  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
   IN UINTN                                  ModeNumber,\r
   OUT UINTN                                 *Columns,\r
   OUT UINTN                                 *Rows\r
@@ -247,8 +254,8 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_TEXT_SET_MODE) (\r
-  IN EFI_SIMPLE_TEXT_OUT_PROTOCOL           *This,\r
+(EFIAPI *EFI_TEXT_SET_MODE)(\r
+  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
   IN UINTN                                  ModeNumber\r
   )\r
 ;\r
@@ -269,8 +276,8 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_TEXT_SET_ATTRIBUTE) (\r
-  IN EFI_SIMPLE_TEXT_OUT_PROTOCOL           *This,\r
+(EFIAPI *EFI_TEXT_SET_ATTRIBUTE)(\r
+  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
   IN UINTN                                  Attribute\r
   )\r
 ;\r
@@ -288,8 +295,8 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_TEXT_CLEAR_SCREEN) (\r
-  IN EFI_SIMPLE_TEXT_OUT_PROTOCOL   *This\r
+(EFIAPI *EFI_TEXT_CLEAR_SCREEN)(\r
+  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   *This\r
   )\r
 ;\r
 \r
@@ -312,8 +319,8 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_TEXT_SET_CURSOR_POSITION) (\r
-  IN EFI_SIMPLE_TEXT_OUT_PROTOCOL           *This,\r
+(EFIAPI *EFI_TEXT_SET_CURSOR_POSITION)(\r
+  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
   IN UINTN                                  Column,\r
   IN UINTN                                  Row\r
   )\r
@@ -335,8 +342,8 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_TEXT_ENABLE_CURSOR) (\r
-  IN EFI_SIMPLE_TEXT_OUT_PROTOCOL           *This,\r
+(EFIAPI *EFI_TEXT_ENABLE_CURSOR)(\r
+  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
   IN BOOLEAN                                Visible\r
   )\r
 ;\r
@@ -365,7 +372,7 @@ typedef struct {
   BOOLEAN CursorVisible;\r
 } EFI_SIMPLE_TEXT_OUTPUT_MODE;\r
 \r
-struct _EFI_SIMPLE_TEXT_OUT_PROTOCOL {\r
+struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL {\r
   EFI_TEXT_RESET                Reset;\r
 \r
   EFI_TEXT_STRING               OutputString;\r