Fix doxygen comment for structure and macro

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

diff --git a/MdePkg/Include/Protocol/HiiFont.h b/MdePkg/Include/Protocol/HiiFont.h
index f2da3068fb90b41d6be72cf6cc7904bb041647a2..02cab77ba3820f3a0dc6b0877594ff88fdacb7db 100644 (file)
--- a/MdePkg/Include/Protocol/HiiFont.h
+++ b/MdePkg/Include/Protocol/HiiFont.h
@@ -25,10 +25,11 @@ typedef struct _EFI_HII_FONT_PROTOCOL EFI_HII_FONT_PROTOCOL;
 \r
 typedef VOID    *EFI_FONT_HANDLE;\r
 \r
-//\r
-// EFI_HII_OUT_FLAGS\r
-// \r
+///\r
+/// EFI_HII_OUT_FLAGS\r
+/// \r
 typedef UINT32  EFI_HII_OUT_FLAGS;\r
+\r
 #define EFI_HII_OUT_FLAG_CLIP         0x00000001\r
 #define EFI_HII_OUT_FLAG_WRAP         0x00000002\r
 #define EFI_HII_OUT_FLAG_CLIP_CLEAN_Y 0x00000004\r
@@ -39,38 +40,32 @@ typedef UINT32  EFI_HII_OUT_FLAGS;
 #define EFI_HII_DIRECT_TO_SCREEN      0x00000080\r
 \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
-\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
-  @param LineHeight     The height of the line, in pixels.\r
-\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
-                        none.\r
-\r
 **/\r
 typedef struct _EFI_HII_ROW_INFO {\r
+  ///\r
+  /// The index of the first character in the string which is displayed on the line.\r
+  ///\r
   UINTN   StartIndex;\r
+  ///\r
+  /// The index of the last character in the string which is displayed on the line.\r
+  /// If this is the same as StartIndex, then no characters are displayed.  \r
+  ///\r
   UINTN   EndIndex;\r
-  UINTN   LineHeight;\r
-  UINTN   LineWidth;\r
+  UINTN   LineHeight; ///< The height of the line, in pixels.\r
+  UINTN   LineWidth;  ///< The width of the text on the line, in pixels.\r
+  \r
+  ///\r
+  /// The number of pixels above the bottom of the row of the font baseline or 0 if none.  \r
+  ///\r
   UINTN   BaselineOffset;\r
 } EFI_HII_ROW_INFO;\r
 \r
-//\r
-// EFI_FONT_INFO_MASK\r
-// \r
+///\r
+/// EFI_FONT_INFO_MASK\r
+/// \r
 typedef UINT32  EFI_FONT_INFO_MASK;\r
+\r
 #define EFI_FONT_INFO_SYS_FONT        0x00000001\r
 #define EFI_FONT_INFO_SYS_SIZE        0x00000002\r
 #define EFI_FONT_INFO_SYS_STYLE       0x00000004\r
@@ -87,7 +82,7 @@ typedef UINT32  EFI_FONT_INFO_MASK;
 // \r
 typedef struct {\r
   EFI_HII_FONT_STYLE FontStyle;\r
-  UINT16             FontSize; // character cell height in pixels\r
+  UINT16             FontSize;      ///< character cell height in pixels\r
   CHAR16             FontName[1];\r
 } EFI_FONT_INFO;\r
 \r
@@ -127,22 +122,6 @@ typedef struct {
   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
-\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 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
@@ -503,15 +482,6 @@ EFI_STATUS
 /**\r
   @par Protocol Description:\r
   The protocol provides the service to retrieve the font informations.\r
-\r
-  @param StringToImage    Render a string to a bitmap or to the display.\r
-\r
-  @param StringIdToImage  Render a string to a bitmap or to the display.\r
-\r
-  @param GetGlyph         Return a specific glyph in a specific font.\r
-\r
-  @param GetFontInfo      Return font information for a specific font.\r
-\r
 **/\r
 struct _EFI_HII_FONT_PROTOCOL {\r
   EFI_HII_STRING_TO_IMAGE     StringToImage;\r