Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/SimpleTextOut.h b/MdePkg/Include/Protocol/SimpleTextOut.h
index 8ed4598dfce6ad2f45e50aa23b4c9744278a93b1..5361e5c03d648c35e56dd14587650c1c3a032b64 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
@@ -162,7 +162,7 @@ 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
@@ -349,14 +349,26 @@ EFI_STATUS
 ;\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 +384,43 @@ typedef struct {
   BOOLEAN CursorVisible;\r
 } EFI_SIMPLE_TEXT_OUTPUT_MODE;\r
 \r
+/**  \r
+  @par Protocol Description:\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
+  @param Reset\r
+  Reset the ConsoleOut device. \r
+\r
+  @param OutputString\r
+  Displays the Unicode string on the device at the current cursor location. \r
+\r
+  @param TestString\r
+  Tests to see if the ConsoleOut device supports this Unicode string.\r
+\r
+  @param QueryMode\r
+  Queries information concerning the output device's supported text mode. \r
+\r
+  @param SetMode\r
+  Sets the current mode of the output device. \r
+\r
+  @param SetAttribute\r
+  Sets the foreground and background color of the text that is output. \r
+\r
+  @param ClearScreen\r
+  Clears the screen with the currently set background color. \r
+\r
+  @param SetCursorPosition\r
+  Sets the current cursor position. \r
+\r
+  @param EnableCursor\r
+  Turns the visibility of the cursor on/off. \r
+\r
+  @param Mode\r
+  Pointer to SIMPLE_TEXT_OUTPUT_MODE data. \r
+**/\r
 struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL {\r
   EFI_TEXT_RESET                Reset;\r
 \r