X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FSimpleTextOut.h;h=f2d22030ed2276ef079a86ca93b74125cbf910c2;hp=2ab3fc4645ba2b7320a21525e2280d482ca947a5;hb=41f2ff0b85f3118238aeac8dfda3a657340519a5;hpb=3909993808a3d1dd6432bde1cb186e759e8db78d

diff --git a/MdePkg/Include/Protocol/SimpleTextOut.h b/MdePkg/Include/Protocol/SimpleTextOut.h
index 2ab3fc4645..f2d22030ed 100644
--- a/MdePkg/Include/Protocol/SimpleTextOut.h
+++ b/MdePkg/Include/Protocol/SimpleTextOut.h
@@ -3,7 +3,7 @@
 
   Abstraction of a very simple text based output device like VGA text mode or
   a serial terminal. The Simple Text Out protocol instance can represent
-  a single hardware device or a virtual device that is an agregation
+  a single hardware device or a virtual device that is an aggregation
   of multiple physical devices.
 
   Copyright (c) 2006 - 2008, Intel Corporation                                                         
@@ -137,11 +137,11 @@ typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   SIMPLE_TEXT_OUTPUT_INTERFACE;
 
 //
 // We currently define attributes from 0 - 7F for color manipulations
-// To internally handle the local display characteristics for a particular character, we are defining
-// Bit 7 to signify the local glyph representation for a character.  If turned on, glyphs will be
+// To internally handle the local display characteristics for a particular character, 
+// Bit 7 signifies the local glyph representation for a character.  If turned on, glyphs will be
 // pulled from the wide glyph database and will display locally as a wide character (16 X 19 versus 8 X 19)
 // If bit 7 is off, the narrow glyph database will be used.  This does NOT affect information that is sent to
-// non-local displays (e.g. serial or LAN consoles).
+// non-local displays, such as serial or LAN consoles.
 //
 #define EFI_WIDE_ATTRIBUTE  0x80
 
@@ -263,7 +263,7 @@ EFI_STATUS
                     and must be zero. The valid Attributes are defined in this file.
 
   @retval EFI_SUCCESS     The attribute was set.
-  @retval EFI_DEVICE_     ERROR The device had an error and could not complete the request.
+  @retval EFI_DEVICE_ERROR  The device had an error and could not complete the request.
   @retval EFI_UNSUPPORTED The attribute requested is not defined.
 
 **/
@@ -340,76 +340,46 @@ EFI_STATUS
 /**
   @par Data Structure Description:
   Mode Structure pointed to by Simple Text Out protocol.
-
-  @param MaxMode
-  The number of modes supported by QueryMode () and SetMode ().
-  
-  @param Mode
-  The text mode of the output device(s).
-  
-  @param Attribute
-  The current character output attribute
-  
-  @param CursorColumn
-  The cursor's column.
-  
-  @param CursorRow
-  The cursor's row.
-  
-  @param CursorVisible
-  The cursor is currently visbile or not.
-
 **/
 typedef struct {
+///
+/// The number of modes supported by QueryMode () and SetMode ().
+///
   INT32   MaxMode;
 
   //
   // current settings
   //
+
+///
+/// The text mode of the output device(s).
+///
   INT32   Mode;
+
+///
+/// The current character output attribute
+///
   INT32   Attribute;
+///
+/// The cursor's column.
+///
   INT32   CursorColumn;
+///
+/// The cursor's row.
+///
   INT32   CursorRow;
+///
+/// The cursor is currently visbile or not.
+///
   BOOLEAN CursorVisible;
 } EFI_SIMPLE_TEXT_OUTPUT_MODE;
 
-/**  
-  @par Protocol Description:
-  The SIMPLE_TEXT_OUTPUT protocol is used to control text-based output devices. 
-  It is the minimum required protocol for any handle supplied as the ConsoleOut 
-  or StandardError device. In addition, the minimum supported text mode of such 
-  devices is at least 80 x 25 characters.
-
-  @param Reset
-  Reset the ConsoleOut device. 
-
-  @param OutputString
-  Displays the Unicode string on the device at the current cursor location. 
-
-  @param TestString
-  Tests to see if the ConsoleOut device supports this Unicode string.
-
-  @param QueryMode
-  Queries information concerning the output device's supported text mode. 
-
-  @param SetMode
-  Sets the current mode of the output device. 
-
-  @param SetAttribute
-  Sets the foreground and background color of the text that is output. 
-
-  @param ClearScreen
-  Clears the screen with the currently set background color. 
-
-  @param SetCursorPosition
-  Sets the current cursor position. 
-
-  @param EnableCursor
-  Turns the visibility of the cursor on/off. 
-
-  @param Mode
-  Pointer to SIMPLE_TEXT_OUTPUT_MODE data. 
-**/
+///
+/// The SIMPLE_TEXT_OUTPUT protocol is used to control text-based output devices. 
+/// It is the minimum required protocol for any handle supplied as the ConsoleOut 
+/// or StandardError device. In addition, the minimum supported text mode of such 
+/// devices is at least 80 x 25 characters.
+///
 struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL {
   EFI_TEXT_RESET                Reset;
 
@@ -424,9 +394,9 @@ struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL {
   EFI_TEXT_SET_CURSOR_POSITION  SetCursorPosition;
   EFI_TEXT_ENABLE_CURSOR        EnableCursor;
 
-  //
-  // Current mode
-  //
+  ///
+  /// Pointer to SIMPLE_TEXT_OUTPUT_MODE data.
+  ///
   EFI_SIMPLE_TEXT_OUTPUT_MODE   *Mode;
 };