Fix a typo

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

diff --git a/MdePkg/Include/Protocol/SimpleTextOut.h b/MdePkg/Include/Protocol/SimpleTextOut.h
index 8ed4598dfce6ad2f45e50aa23b4c9744278a93b1..a55b407f10afba9fb5ed9ecf056b2cad6d3f57c7 100644 (file)
--- a/MdePkg/Include/Protocol/SimpleTextOut.h
+++ b/MdePkg/Include/Protocol/SimpleTextOut.h
@@ -6,7 +6,7 @@
   a single hardware device or a virtual device that is an agregation\r
   of multiple physical devices.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -20,23 +20,21 @@
 #ifndef __SIMPLE_TEXT_OUT_H__\r
 #define __SIMPLE_TEXT_OUT_H__\r
 \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
-//\r
-// Protocol GUID defined in EFI1.1.\r
-// \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_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL;\r
 \r
-//\r
-// Backward-compatible with EFI1.1.\r
-// \r
+///\r
+/// Backward-compatible with EFI1.1.\r
+/// \r
 typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   SIMPLE_TEXT_OUTPUT_INTERFACE;\r
 \r
 //\r
@@ -162,10 +160,9 @@ typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   SIMPLE_TEXT_OUTPUT_INTERFACE;
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_TEXT_RESET)(\r
-  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL           *This,\r
+  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
   IN BOOLEAN                                ExtendedVerification\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Write a Unicode string to the output device.\r
@@ -190,8 +187,7 @@ EFI_STATUS
 (EFIAPI *EFI_TEXT_STRING)(\r
   IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
   IN CHAR16                                 *String\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Verifies that all characters in a Unicode string can be output to the \r
@@ -212,8 +208,7 @@ EFI_STATUS
 (EFIAPI *EFI_TEXT_TEST_STRING)(\r
   IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
   IN CHAR16                                 *String\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Returns information for an available text mode that the output device(s)\r
@@ -238,8 +233,7 @@ EFI_STATUS
   IN UINTN                                  ModeNumber,\r
   OUT UINTN                                 *Columns,\r
   OUT UINTN                                 *Rows\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Sets the output device(s) to a specified mode.\r
@@ -257,8 +251,7 @@ EFI_STATUS
 (EFIAPI *EFI_TEXT_SET_MODE)(\r
   IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
   IN UINTN                                  ModeNumber\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Sets the background and foreground colors for the OutputString () and\r
@@ -279,8 +272,7 @@ EFI_STATUS
 (EFIAPI *EFI_TEXT_SET_ATTRIBUTE)(\r
   IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
   IN UINTN                                  Attribute\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Clears the output device(s) display to the currently selected background \r
@@ -297,8 +289,7 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_TEXT_CLEAR_SCREEN)(\r
   IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   *This\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Sets the current coordinates of the cursor position\r
@@ -323,8 +314,7 @@ EFI_STATUS
   IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
   IN UINTN                                  Column,\r
   IN UINTN                                  Row\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Makes the cursor visible or invisible\r
@@ -345,18 +335,29 @@ EFI_STATUS
 (EFIAPI *EFI_TEXT_ENABLE_CURSOR)(\r
   IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL        *This,\r
   IN BOOLEAN                                Visible\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
+  @par Data Structure Description:\r
   Mode Structure pointed to by Simple Text Out protocol.\r
 \r
-  MaxMode   - The number of modes supported by QueryMode () and SetMode ().\r
-  Mode      - The text mode of the output device(s).\r
-  Attribute - The current character output attribute\r
-  CursorColumn  - The cursor's column.\r
-  CursorRow     - The cursor's row.\r
-  CursorVisible - The cursor is currently visbile or not.\r
+  @param MaxMode\r
+  The number of modes supported by QueryMode () and SetMode ().\r
+  \r
+  @param Mode\r
+  The text mode of the output device(s).\r
+  \r
+  @param Attribute\r
+  The current character output attribute\r
+  \r
+  @param CursorColumn\r
+  The cursor's column.\r
+  \r
+  @param CursorRow\r
+  The cursor's row.\r
+  \r
+  @param CursorVisible\r
+  The cursor is currently visbile or not.\r
 \r
 **/\r
 typedef struct {\r
@@ -372,6 +373,12 @@ typedef struct {
   BOOLEAN CursorVisible;\r
 } EFI_SIMPLE_TEXT_OUTPUT_MODE;\r
 \r
+///\r
+/// The SIMPLE_TEXT_OUTPUT protocol is used to control text-based output devices. \r
+/// It is the minimum required protocol for any handle supplied as the ConsoleOut \r
+/// or StandardError device. In addition, the minimum supported text mode of such \r
+/// devices is at least 80 x 25 characters.\r
+///\r
 struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL {\r
   EFI_TEXT_RESET                Reset;\r
 \r
@@ -386,9 +393,9 @@ struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL {
   EFI_TEXT_SET_CURSOR_POSITION  SetCursorPosition;\r
   EFI_TEXT_ENABLE_CURSOR        EnableCursor;\r
 \r
-  //\r
-  // Current mode\r
-  //\r
+  ///\r
+  /// Pointer to SIMPLE_TEXT_OUTPUT_MODE data.\r
+  ///\r
   EFI_SIMPLE_TEXT_OUTPUT_MODE   *Mode;\r
 };\r
 \r