Add the detailed descriptions for the structure data member in these protocol.

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

diff --git a/MdePkg/Include/Protocol/HiiFont.h b/MdePkg/Include/Protocol/HiiFont.h
index dd19f29012264ec6fd473129a77cec74a532357a..9145089734ecff62029e8f18d19221a976e6e82f 100644 (file)
--- a/MdePkg/Include/Protocol/HiiFont.h
+++ b/MdePkg/Include/Protocol/HiiFont.h
@@ -62,8 +62,9 @@ typedef struct _EFI_HII_ROW_INFO {
 } EFI_HII_ROW_INFO;\r
 \r
 ///\r
-/// EFI_FONT_INFO_MASK\r
-/// \r
+/// Font info flag. All flags (FONT, SIZE, STYLE, and COLOR) are defined.\r
+/// They are defined as EFI_FONT_INFO_***\r
+///\r
 typedef UINT32  EFI_FONT_INFO_MASK;\r
 \r
 #define EFI_FONT_INFO_SYS_FONT        0x00000001\r
@@ -87,6 +88,8 @@ typedef struct {
 } EFI_FONT_INFO;\r
 \r
 /**\r
+  Describes font output-related information.\r
+\r
   This structure is used for describing the way in which a string\r
   should be rendered in a particular font. FontInfo specifies the\r
   basic font information and ForegroundColor and BackgroundColor\r
@@ -94,34 +97,7 @@ typedef struct {
   in FontInfoMask describe where the system default should be\r
   supplied instead of the specified information. The flags also\r
   describe what options can be used to make a match between the\r
-  font requested and the font available. If EFI_FONT_INFO_SYS_FONT\r
-  is specified, then the font name in FontInfo is ignored and the\r
-  system font name is used. This flag cannot be used with\r
-  EFI_FONT_INFO_ANY_FONT. If EFI_FONT_INFO_SYS_SIZE is specified,\r
-  then the font height specified in FontInfo is ignored and the\r
-  system font height is used instead. This flag cannot be used\r
-  with EFI_FONT_INFO_ANY_SIZE. If EFI_FONT_INFO_SYS_STYLE is\r
-  specified, then the font style in FontInfo is ignored and the\r
-  system font style is used. This flag cannot be used with\r
-  EFI_FONT_INFO_ANY_STYLE. If EFI_FONT_INFO_SYS_FORE_COLOR is\r
-  specified, then ForegroundColor is ignored and the system\r
-  foreground color is used. If EFI_FONT_INFO_SYS_BACK_COLOR is\r
-  specified, then BackgroundColor is ignored and the system\r
-  background color is used. If EFI_FONT_INFO_RESIZE is specified,\r
-  then the system may attempt to stretch or shrink a font to meet\r
-  the size requested. This flag cannot be used with\r
-  EFI_FONT_INFO_ANY_SIZE. If EFI_FONT_INFO_RESTYLE is specified,\r
-  then the system may attempt to remove some of the specified\r
-  styles in order to meet the style requested. This flag cannot be\r
-  used with EFI_FONT_INFO_ANY_STYLE. If EFI_FONT_INFO_ANY_FONT is\r
-  specified, then the system may attempt to match with any font.\r
-  This flag cannot be used with EFI_FONT_INFO_SYS_FONT. If\r
-  EFI_FONT_INFO_ANY_SIZE is specified, then the system may attempt\r
-  to match with any font size. This flag cannot be used with\r
-  EFI_FONT_INFO_SYS_SIZE or EFI_FONT_INFO_RESIZE. If\r
-  EFI_FONT_INFO_ANY_STYLE is specified, then the system may\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
+  font requested and the font available.\r
 **/\r
 typedef struct _EFI_FONT_DISPLAY_INFO {\r
   EFI_GRAPHICS_OUTPUT_BLT_PIXEL ForegroundColor;\r