Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/HiiFont.h b/MdePkg/Include/Protocol/HiiFont.h
index de2097e744fe775df8b68920d0065cba1370a6a4..f2da3068fb90b41d6be72cf6cc7904bb041647a2 100644 (file)
--- a/MdePkg/Include/Protocol/HiiFont.h
+++ b/MdePkg/Include/Protocol/HiiFont.h
@@ -42,18 +42,17 @@ typedef UINT32  EFI_HII_OUT_FLAGS;
 \r
   Definition of EFI_HII_ROW_INFO.\r
 \r
 \r
   Definition of EFI_HII_ROW_INFO.\r
 \r

-  @param StartIndex The index of the first character in the\r
-                    string which is displayed on the line.\r
+  @param StartIndex     The index of the first character in the\r
+                        string which is displayed on the line.\r

 \r
 \r

-  @param EndIndex The index of the last character in the string\r
-                  which is displayed on the line. If this is the\r
-                  same as StartIndex, then no characters are\r
-                  displayed.\r
+  @param EndIndex       The index of the last character in the string\r
+                        which is displayed on the line. If this is the\r
+                        same as StartIndex, then no characters are\r
+                        displayed.\r

 \r
 \r

-  @param LineHeight The height of the line, in pixels.\r
+  @param LineHeight     The height of the line, in pixels.\r

 \r
 \r

-  @param LineWidth  The width of the text on the line, in\r
-                    pixels.\r
+  @param LineWidth      The width of the text on the line, in pixels.\r

 \r
   @param BaselineOffset The number of pixels above the bottom of\r
                         the row of the font baseline or 0 if\r
 \r
   @param BaselineOffset The number of pixels above the bottom of\r
                         the row of the font baseline or 0 if\r


@@ -129,20 +128,21 @@ typedef struct {
   attempt to match with any font style. This flag cannot be used\r
   with EFI_FONT_INFO_SYS_STYLE or EFI_FONT_INFO_RESTYLE.\r
 \r
   attempt to match with any font style. This flag cannot be used\r
   with EFI_FONT_INFO_SYS_STYLE or EFI_FONT_INFO_RESTYLE.\r
 \r

-  @param FontInfo Points to the font information or NULL if the\r
-                  string should use the default system font.\r
-  \r
+\r

   @param ForegroundColor  The color of the "on" pixels in the\r
                           glyph in the bitmap.\r
   \r
   @param BackgroundColor  The color of the "off" pixels in the\r
                           glyph in the bitmap.\r
   \r
   @param ForegroundColor  The color of the "on" pixels in the\r
                           glyph in the bitmap.\r
   \r
   @param BackgroundColor  The color of the "off" pixels in the\r
                           glyph in the bitmap.\r
   \r

-  @param FontInfoMask   The font information mask determines\r
-                        which portion of the font information\r
-                        will be used and what to do if the\r
-                        specific font is not available.\r
-  \r
+  @param FontInfoMask     The font information mask determines\r
+                          which portion of the font information\r
+                          will be used and what to do if the\r
+                          specific font is not available.\r
+\r
+  @param FontInfo         Points to the font information or NULL if the\r
+                          string should use the default system font.\r
+    \r

 **/\r
 typedef struct _EFI_FONT_DISPLAY_INFO {\r
   EFI_GRAPHICS_OUTPUT_BLT_PIXEL ForegroundColor;\r
 **/\r
 typedef struct _EFI_FONT_DISPLAY_INFO {\r
   EFI_GRAPHICS_OUTPUT_BLT_PIXEL ForegroundColor;\r


@@ -172,11 +172,11 @@ typedef struct _EFI_FONT_DISPLAY_INFO {
   EFI_HII_OUT_FLAG_CLIP_CLEAN_X is specified) even though those\r
   pixels were not drawn. If EFI_HII_OUT_FLAG_CLIP_CLEAN_X is set,\r
   then it modifies the behavior of EFI_HII_OUT_FLAG_CLIP so that\r
   EFI_HII_OUT_FLAG_CLIP_CLEAN_X is specified) even though those\r
   pixels were not drawn. If EFI_HII_OUT_FLAG_CLIP_CLEAN_X is set,\r
   then it modifies the behavior of EFI_HII_OUT_FLAG_CLIP so that\r

-  if a character????s right-most on pixel cannot fit, then it will\r
+  if a character's right-most on pixel cannot fit, then it will\r

   not be drawn at all. This flag requires that\r
   EFI_HII_OUT_FLAG_CLIP be set. If EFI_HII_OUT_FLAG_CLIP_CLEAN_Y\r
   is set, then it modifies the behavior of EFI_HII_OUT_FLAG_CLIP\r
   not be drawn at all. This flag requires that\r
   EFI_HII_OUT_FLAG_CLIP be set. If EFI_HII_OUT_FLAG_CLIP_CLEAN_Y\r
   is set, then it modifies the behavior of EFI_HII_OUT_FLAG_CLIP\r

-  so that if a row????s bottom-most pixel cannot fit, then it will\r
+  so that if a row's bottom-most pixel cannot fit, then it will\r

   not be drawn at all. This flag requires that\r
   EFI_HII_OUT_FLAG_CLIP be set. If EFI_HII_OUT_FLAG_WRAP is set,\r
   then text will be wrapped at the right-most line-break\r
   not be drawn at all. This flag requires that\r
   EFI_HII_OUT_FLAG_CLIP be set. If EFI_HII_OUT_FLAG_WRAP is set,\r
   then text will be wrapped at the right-most line-break\r


@@ -185,7 +185,7 @@ typedef struct _EFI_FONT_DISPLAY_INFO {
   the text will behave as if EFI_HII_OUT_FLAG_CLIP_CLEAN_X is set.\r
   This flag cannot be used with EFI_HII_OUT_FLAG_CLIP_CLEAN_X. If\r
   EFI_HII_OUT_FLAG_TRANSPARENT is set, then BackgroundColor is\r
   the text will behave as if EFI_HII_OUT_FLAG_CLIP_CLEAN_X is set.\r
   This flag cannot be used with EFI_HII_OUT_FLAG_CLIP_CLEAN_X. If\r
   EFI_HII_OUT_FLAG_TRANSPARENT is set, then BackgroundColor is\r

-  ignored and all ????off???? pixels in the character????s drawn\r
+  ignored and all 'off' pixels in the character's drawn\r

   will use the pixel value from Blt. This flag cannot be used if\r
   Blt is NULL upon entry. If EFI_HII_IGNORE_IF_NO_GLYPH is set,\r
   then characters which have no glyphs are not drawn. Otherwise,\r
   will use the pixel value from Blt. This flag cannot be used if\r
   Blt is NULL upon entry. If EFI_HII_IGNORE_IF_NO_GLYPH is set,\r
   then characters which have no glyphs are not drawn. Otherwise,\r


@@ -196,45 +196,44 @@ typedef struct _EFI_FONT_DISPLAY_INFO {
   directly to the output device specified by Screen. Otherwise the\r
   string will be rendered to the bitmap specified by Bitmap.\r
 \r
   directly to the output device specified by Screen. Otherwise the\r
   string will be rendered to the bitmap specified by Bitmap.\r
 \r

-  @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.\r
+  @param This             A pointer to the EFI_HII_FONT_PROTOCOL instance.\r

 \r
 \r

-  @param Flags  Describes how the string is to be drawn.\r
+  @param Flags            Describes how the string is to be drawn.\r

 \r
 \r

-  @param String Points to the null-terminated string to be\r
-                displayed.\r
+  @param String           Points to the null-terminated string to be \r

 \r
 \r

-  @param StringInfo Points to the string output information,\r
-                    including the color and font. If NULL, then\r
-                    the string will be output in the default\r
-                    system font and color.\r
+  @param StringInfo       Points to the string output information,\r
+                          including the color and font. If NULL, then\r
+                          the string will be output in the default\r
+                          system font and color.\r

 \r
 \r

-  @param Blt  If this points to a non-NULL on entry, this points\r
-              to the image, which is Width pixels wide and\r
-              Height pixels high. The string will be drawn onto\r
-              this image and EFI_HII_OUT_FLAG_CLIP is implied.\r
-              If this points to a NULL on entry, then a buffer\r
-              will be allocated to hold the generated image and\r
-              the pointer updated on exit. It is the caller's\r
-              responsibility to free this buffer.\r
+  @param Blt              If this points to a non-NULL on entry, this points\r
+                          to the image, which is Width pixels wide and\r
+                          Height pixels high. The string will be drawn onto\r
+                          this image and EFI_HII_OUT_FLAG_CLIP is implied.\r
+                          If this points to a NULL on entry, then a buffer\r
+                          will be allocated to hold the generated image and\r
+                          the pointer updated on exit. It is the caller's\r
+                          responsibility to free this buffer.\r

 \r
 \r

-  @param BltX, BltY Specifies the offset from the left and top\r
-                    edge of the image of the first character\r
-                    cell in the image.\r
-\r
-  @param RowInfoArray If this is non-NULL on entry, then on\r
-                    exit, this will point to an allocated buffer\r
-                    containing row information and\r
-                    RowInfoArraySize will be updated to contain\r
-                    the number of elements. This array describes\r
-                    the characters which were at least partially\r
-                    drawn and the heights of the rows. It is the\r
-                    caller's responsibility to free this buffer.\r
+  @param BltX, BltY       Specifies the offset from the left and top\r
+                          edge of the image of the first character\r
+                          cell in the image.\r
+\r
+  @param RowInfoArray     If this is non-NULL on entry, then on\r
+                          exit, this will point to an allocated buffer\r
+                          containing row information and\r
+                          RowInfoArraySize will be updated to contain\r
+                          the number of elements. This array describes\r
+                          the characters which were at least partially\r
+                          drawn and the heights of the rows. It is the\r
+                          caller's responsibility to free this buffer.\r

 \r
   @param RowInfoArraySize If this is non-NULL on entry, then on\r
                           exit it contains the number of\r
                           elements in RowInfoArray.\r
 \r
 \r
   @param RowInfoArraySize If this is non-NULL on entry, then on\r
                           exit it contains the number of\r
                           elements in RowInfoArray.\r
 \r

-  @param ColumnInfoArray If this is non-NULL, then on return it\r
+  @param ColumnInfoArray  If this is non-NULL, then on return it\r

                           will be filled with the horizontal\r
                           offset for each character in the\r
                           string on the row where it is\r
                           will be filled with the horizontal\r
                           offset for each character in the\r
                           string on the row where it is\r


@@ -248,14 +247,13 @@ typedef struct _EFI_FONT_DISPLAY_INFO {
                           normalized that some character cells\r
                           overlap.\r
 \r
                           normalized that some character cells\r
                           overlap.\r
 \r

-  @retval EFI_SUCCESS The string was successfully updated.\r
+  @retval EFI_SUCCESS           The string was successfully updated.\r

   \r
   \r

-  @retval EFI_OUT_OF_RESOURCES  Unable to allocate an output\r
-                                buffer for RowInfoArray or Blt.\r
+  @retval EFI_OUT_OF_RESOURCES  Unable to allocate an output buffer for RowInfoArray or Blt.\r

   \r
   \r

-  @retval EFI_INVALID_PARAMETER The String or Blt.\r
-  @retval EFI_INVALID_PARAMETER Flags were invalid combination..\r
+  @retval EFI_INVALID_PARAMETER The String or Blt was NULL.\r

 \r
 \r

+  @retval EFI_INVALID_PARAMETER Flags were invalid combination.\r

 **/\r
 typedef\r
 EFI_STATUS\r
 **/\r
 typedef\r
 EFI_STATUS\r


@@ -292,11 +290,11 @@ EFI_STATUS
   specified by Height (unless EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is\r
   specified) even though those pixels were not drawn. If\r
   EFI_HII_OUT_FLAG_CLIP_CLEAN_X is set, then it modifies the\r
   specified by Height (unless EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is\r
   specified) even though those pixels were not drawn. If\r
   EFI_HII_OUT_FLAG_CLIP_CLEAN_X is set, then it modifies the\r

-  behavior of EFI_HII_OUT_FLAG_CLIP so that if a character????s\r
+  behavior of EFI_HII_OUT_FLAG_CLIP so that if a character's\r

   right-most on pixel cannot fit, then it will not be drawn at\r
   all. This flag requires that EFI_HII_OUT_FLAG_CLIP be set. If\r
   EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is set, then it modifies the\r
   right-most on pixel cannot fit, then it will not be drawn at\r
   all. This flag requires that EFI_HII_OUT_FLAG_CLIP be set. If\r
   EFI_HII_OUT_FLAG_CLIP_CLEAN_Y is set, then it modifies the\r

-  behavior of EFI_HII_OUT_FLAG_CLIP so that if a row????s bottom\r
+  behavior of EFI_HII_OUT_FLAG_CLIP so that if a row's bottom\r

   most pixel cannot fit, then it will not be drawn at all. This\r
   flag requires that EFI_HII_OUT_FLAG_CLIP be set. Draft for\r
   Review HII Protocols Version 2.1 November 3, 2006 1285 If\r
   most pixel cannot fit, then it will not be drawn at all. This\r
   flag requires that EFI_HII_OUT_FLAG_CLIP be set. Draft for\r
   Review HII Protocols Version 2.1 November 3, 2006 1285 If\r


@@ -320,12 +318,13 @@ EFI_STATUS
   by Bitmap.\r
 \r
 \r
   by Bitmap.\r
 \r
 \r

-  @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.\r
+  @param This       A pointer to the EFI_HII_FONT_PROTOCOL instance.\r

 \r
 \r

-  @param Flags  Describes how the string is to be drawn.\r
+  @param Flags      Describes how the string is to be drawn.\r

 \r
 \r

-  @param PackageList  The package list in the HII database to\r
-                      search for the specified string.\r
+  @param PackageList  \r
+                    The package list in the HII database to\r
+                    search for the specified string.\r

 \r
   @param StringId   The string's id, which is unique within\r
                     PackageList.\r
 \r
   @param StringId   The string's id, which is unique within\r
                     PackageList.\r


@@ -339,28 +338,28 @@ EFI_STATUS
                     the string will be output in the default\r
                     system font and color.\r
 \r
                     the string will be output in the default\r
                     system font and color.\r
 \r

-  @param Blt  If this points to a non-NULL on entry, this points\r
-              to the image, which is Width pixels wide and\r
-              Height pixels high. The string will be drawn onto\r
-              this image and EFI_HII_OUT_FLAG_CLIP is implied.\r
-              If this points to a NULL on entry, then a buffer\r
-              will be allocated to hold the generated image and\r
-              the pointer updated on exit. It is the caller's\r
-              responsibility to free this buffer.\r
+  @param Blt        If this points to a non-NULL on entry, this points\r
+                    to the image, which is Width pixels wide and\r
+                    Height pixels high. The string will be drawn onto\r
+                    this image and EFI_HII_OUT_FLAG_CLIP is implied.\r
+                    If this points to a NULL on entry, then a buffer\r
+                    will be allocated to hold the generated image and\r
+                    the pointer updated on exit. It is the caller's\r
+                    responsibility to free this buffer.\r

 \r
   @param BltX, BltY Specifies the offset from the left and top\r
                     edge of the output image of the first\r
                     character cell in the image.\r
 \r
 \r
   @param BltX, BltY Specifies the offset from the left and top\r
                     edge of the output image of the first\r
                     character cell in the image.\r
 \r

-  @param RowInfoArray If this is non-NULL on entry, then on\r
-                      exit, this will point to an allocated\r
-                      buffer containing row information and\r
-                      RowInfoArraySize will be updated to\r
-                      contain the number of elements. This array\r
-                      describes the characters which were at\r
-                      least partially drawn and the heights of\r
-                      the rows. It is the caller's\r
-                      responsibility to free this buffer.\r
+  @param RowInfoArray     If this is non-NULL on entry, then on\r
+                          exit, this will point to an allocated\r
+                          buffer containing row information and\r
+                          RowInfoArraySize will be updated to\r
+                          contain the number of elements. This array\r
+                          describes the characters which were at\r
+                          least partially drawn and the heights of\r
+                          the rows. It is the caller's\r
+                          responsibility to free this buffer.\r

 \r
   @param RowInfoArraySize If this is non-NULL on entry, then on\r
                           exit it contains the number of\r
 \r
   @param RowInfoArraySize If this is non-NULL on entry, then on\r
                           exit it contains the number of\r


@@ -380,7 +379,7 @@ EFI_STATUS
                           some character cells overlap.\r
 \r
 \r
                           some character cells overlap.\r
 \r
 \r

-  @retval EFI_SUCCESS The string was successfully updated.\r
+  @retval EFI_SUCCESS           The string was successfully updated.\r

 \r
   @retval EFI_OUT_OF_RESOURCES  Unable to allocate an output\r
                                 buffer for RowInfoArray or Blt.\r
 \r
   @retval EFI_OUT_OF_RESOURCES  Unable to allocate an output\r
                                 buffer for RowInfoArray or Blt.\r


@@ -388,9 +387,9 @@ EFI_STATUS
   @retval EFI_INVALID_PARAMETER The String or Blt or Height or\r
                                 Width was NULL.\r
   @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.\r
   @retval EFI_INVALID_PARAMETER The String or Blt or Height or\r
                                 Width was NULL.\r
   @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.\r

-  @retval EFI_INVALID_PARAMETER  Flags were invalid combination.\r
-  @retval EFI_NOT_FOUND   The specified PackageList is not in the Database or the stringid is not \r
-                        in the specified PackageList. \r
+  @retval EFI_INVALID_PARAMETER Flags were invalid combination.\r
+  @retval EFI_NOT_FOUND         The specified PackageList is not in the Database \r
+                                or the stringid is not in the specified PackageList. \r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -415,34 +414,33 @@ EFI_STATUS
 \r
   Convert the glyph for a single character into a bitmap.\r
 \r
 \r
   Convert the glyph for a single character into a bitmap.\r
 \r

-  @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.\r
+  @param This       A pointer to the EFI_HII_FONT_PROTOCOL instance.\r

 \r
 \r

-  @param Char Character to retrieve.\r
+  @param Char       Character to retrieve.\r

 \r
   @param StringInfo Points to the string font and color\r
                     information or NULL if the string should use\r
                     the default system font and color.\r
 \r
 \r
   @param StringInfo Points to the string font and color\r
                     information or NULL if the string should use\r
                     the default system font and color.\r
 \r

-  @param Blt  Thus must point to a NULL on entry. A buffer will\r
-              be allocated to hold the output and the pointer\r
-              updated on exit. It is the caller's responsibility\r
-              to free this buffer.\r
+  @param Blt        Thus must point to a NULL on entry. A buffer will\r
+                    be allocated to hold the output and the pointer\r
+                    updated on exit. It is the caller's responsibility\r
+                    to free this buffer.\r

 \r
 \r

-  @param Baseline Number of pixels from the bottom of the bitmap\r
-                  to the baseline.\r
+  @param Baseline   Number of pixels from the bottom of the bitmap\r
+                    to the baseline.\r

 \r
 \r
 \r
 \r

-  @retval EFI_SUCCESS Glyph bitmap created.\r
+  @retval EFI_SUCCESS             Glyph bitmap created.\r

 \r
 \r

-  @retval EFI_OUT_OF_RESOURCES  Unable to allocate the output\r
-                                buffer Blt.\r
+  @retval EFI_OUT_OF_RESOURCES    Unable to allocate the output buffer Blt.\r

 \r
   @retval EFI_WARN_UNKNOWN_GLYPH  The glyph was unknown and was\r
                                   replaced with the glyph for\r
                                   Unicode character 0xFFFD.\r
 \r
 \r
   @retval EFI_WARN_UNKNOWN_GLYPH  The glyph was unknown and was\r
                                   replaced with the glyph for\r
                                   Unicode character 0xFFFD.\r
 \r

-  @retval EFI_INVALID_PARAMETER Blt is NULL or Width is NULL or\r
-                                Height is NULL\r
+  @retval EFI_INVALID_PARAMETER   Blt is NULL or Width is NULL or\r
+                                  Height is NULL\r

 \r
 \r
 **/\r
 \r
 \r
 **/\r


@@ -463,29 +461,29 @@ EFI_STATUS
   all of the characters in the string must exist in order for a\r
   candidate font to be returned.\r
 \r
   all of the characters in the string must exist in order for a\r
   candidate font to be returned.\r
 \r

-  @param This A pointer to the EFI_HII_FONT_PROTOCOL instance.\r
+  @param This           A pointer to the EFI_HII_FONT_PROTOCOL instance.\r

 \r
 \r

-  @param FontHandle On entry, points to the font handle returned\r
-                    by a previous call to GetFontInfo() or NULL\r
-                    to start with the first font. On return,\r
-                    points to the returned font handle or points\r
-                    to NULL if there are no more matching fonts.\r
+  @param FontHandle     On entry, points to the font handle returned\r
+                        by a previous call to GetFontInfo() or NULL\r
+                        to start with the first font. On return,\r
+                        points to the returned font handle or points\r
+                        to NULL if there are no more matching fonts.\r

 \r
 \r

-  @param StringInfoIn Upon entry, points to the font to return\r
-                      information about. If NULL, then the information about the system default \r
-                      font will be returned.\r
+  @param StringInfoIn   Upon entry, points to the font to return\r
+                        information about. If NULL, then the information about the system default \r
+                        font will be returned.\r

 \r
   @param StringInfoOut  Upon return, contains the matching\r
                         font's information. If NULL, then no\r
                         information is returned.\r
 \r
 \r
   @param StringInfoOut  Upon return, contains the matching\r
                         font's information. If NULL, then no\r
                         information is returned.\r
 \r

-  @param String Points to the string which will be tested to\r
-                determine if all characters are available. If\r
-                NULL, then any font is acceptable.\r
+  @param String         Points to the string which will be tested to\r
+                        determine if all characters are available. If\r
+                        NULL, then any font is acceptable.\r

   \r
   \r

-  @retval EFI_SUCCESS Matching font returned successfully.\r
+  @retval EFI_SUCCESS            Matching font returned successfully.\r

   \r
   \r

-  @retval EFI_NOT_FOUND No matching font was found.\r
+  @retval EFI_NOT_FOUND          No matching font was found.\r

   \r
   @retval EFI_INVALID_PARAMETER  StringInfoIn->FontInfoMask is an invalid combination.\r
 \r
   \r
   @retval EFI_INVALID_PARAMETER  StringInfoIn->FontInfoMask is an invalid combination.\r
 \r


@@ -503,19 +501,16 @@ EFI_STATUS
 );\r
 \r
 /**\r
 );\r
 \r
 /**\r

+  @par Protocol Description:\r
+  The protocol provides the service to retrieve the font informations.\r

 \r
 \r

-  The protocol provides the service to retrieve the font\r
-  informations;\r
+  @param StringToImage    Render a string to a bitmap or to the display.\r

 \r
 \r

-  @param StringToImage  Render a string to a bitmap or to the\r
-                        display.\r
+  @param StringIdToImage  Render a string to a bitmap or to the display.\r

 \r
 \r

-  @param StringIdToImage  Render a string to a bitmap or to the\r
-                          display.\r
-  @param GetGlyph Return a specific glyph in a specific font.\r
+  @param GetGlyph         Return a specific glyph in a specific font.\r

 \r
 \r

-  @param GetFontInfo  Return font information for a specific\r
-                      font.\r
+  @param GetFontInfo      Return font information for a specific font.\r

 \r
 **/\r
 struct _EFI_HII_FONT_PROTOCOL {\r
 \r
 **/\r
 struct _EFI_HII_FONT_PROTOCOL {\r