git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8525 6f19259b...

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

diff --git a/MdePkg/Include/Protocol/SimpleTextOut.h b/MdePkg/Include/Protocol/SimpleTextOut.h
index 888ee91df90887a9527b351f51ceb978cd640ff4..f2d22030ed2276ef079a86ca93b74125cbf910c2 100644 (file)
--- a/MdePkg/Include/Protocol/SimpleTextOut.h
+++ b/MdePkg/Include/Protocol/SimpleTextOut.h
@@ -3,7 +3,7 @@
 \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
-  a single hardware device or a virtual device that is an agregation\r
+  a single hardware device or a virtual device that is an aggregation\r
   of multiple physical devices.\r
 \r
   Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
@@ -137,11 +137,11 @@ typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   SIMPLE_TEXT_OUTPUT_INTERFACE;
 \r
 //\r
 // We currently define attributes from 0 - 7F for color manipulations\r
-// To internally handle the local display characteristics for a particular character, we are defining\r
-// Bit 7 to signify the local glyph representation for a character.  If turned on, glyphs will be\r
+// To internally handle the local display characteristics for a particular character, \r
+// Bit 7 signifies the local glyph representation for a character.  If turned on, glyphs will be\r
 // pulled from the wide glyph database and will display locally as a wide character (16 X 19 versus 8 X 19)\r
 // If bit 7 is off, the narrow glyph database will be used.  This does NOT affect information that is sent to\r
-// non-local displays (e.g. serial or LAN consoles).\r
+// non-local displays, such as serial or LAN consoles.\r
 //\r
 #define EFI_WIDE_ATTRIBUTE  0x80\r
 \r
@@ -263,7 +263,7 @@ EFI_STATUS
                     and must be zero. The valid Attributes are defined in this file.\r
 \r
   @retval EFI_SUCCESS     The attribute was set.\r
-  @retval EFI_DEVICE_     ERROR The device had an error and could not complete the request.\r
+  @retval EFI_DEVICE_ERROR  The device had an error and could not complete the request.\r
   @retval EFI_UNSUPPORTED The attribute requested is not defined.\r
 \r
 **/\r
@@ -340,46 +340,46 @@ EFI_STATUS
 /**\r
   @par Data Structure Description:\r
   Mode Structure pointed to by Simple Text Out protocol.\r
-\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
+///\r
+/// The number of modes supported by QueryMode () and SetMode ().\r
+///\r
   INT32   MaxMode;\r
 \r
   //\r
   // current settings\r
   //\r
+\r
+///\r
+/// The text mode of the output device(s).\r
+///\r
   INT32   Mode;\r
+\r
+///\r
+/// The current character output attribute\r
+///\r
   INT32   Attribute;\r
+///\r
+/// The cursor's column.\r
+///\r
   INT32   CursorColumn;\r
+///\r
+/// The cursor's row.\r
+///\r
   INT32   CursorRow;\r
+///\r
+/// The cursor is currently visbile or not.\r
+///\r
   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
+///\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
@@ -394,9 +394,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