Bug fixes for FrameworkHiiToUefiHiiThunk;

[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / FrameworkHiiToUefiHiiThunk / Fonts.c

diff --git a/EdkCompatibilityPkg/Compatibility/FrameworkHiiToUefiHiiThunk/Fonts.c b/EdkCompatibilityPkg/Compatibility/FrameworkHiiToUefiHiiThunk/Fonts.c
index 29914064e54118b0f20e953b7a6af6a35c53bf9a..1d58dcd90849193c2cff1dd0e02ce2425d40e068 100644 (file)
--- a/EdkCompatibilityPkg/Compatibility/FrameworkHiiToUefiHiiThunk/Fonts.c
+++ b/EdkCompatibilityPkg/Compatibility/FrameworkHiiToUefiHiiThunk/Fonts.c
@@ -19,6 +19,23 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 UINT8 mGlyphBuffer[EFI_GLYPH_WIDTH * 2 * EFI_GLYPH_HEIGHT];\r
 \r
+/**\r
+  This function is only called by Graphics Console module and GraphicsLib. \r
+  EDK II provides a UEFI Graphics Console module. ECP provides a GraphicsLib \r
+  complying to UEFI HII.\r
+  \r
+  This function will ASSERT and return EFI_UNSUPPORTED.\r
+\r
+  @param This            N.A.\r
+  @param Source          N.A.\r
+  @param Index           N.A.\r
+  @param GlyphBuffer     N.A.\r
+  @param BitWidth        N.A.\r
+  @param InternalStatus  N.A.\r
+\r
+  @return EFI_UNSUPPORTED N.A.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 HiiGetGlyph (\r
@@ -29,30 +46,30 @@ HiiGetGlyph (
   OUT    UINT16             *BitWidth,\r
   IN OUT UINT32             *InternalStatus\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Translates a Unicode character into the corresponding font glyph.\r
-  If the Source was pointing to a non-spacing character, the next Source[*Index]\r
-  character will be parsed and OR'd to the GlyphBuffer until a spacing character\r
-  is found in the Source.  Since non-spacing characters are considered to be the\r
-  same pixel width as a regular character their BitWidth will be reflected correctly\r
-  however due to their special attribute, they are considered to be zero advancing width.\r
-  This basically means that the cursor would not advance, thus the character that follows\r
-  it would overlay the non-spacing character.  The Index is modified to reflect both the\r
-  incoming array entry into the Source string but also the outgoing array entry after having\r
-  parsed the equivalent of a single Glyph's worth of data.\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
---*/\r
 {\r
   ASSERT (FALSE);\r
   return EFI_UNSUPPORTED;\r
 }\r
 \r
+/**\r
+  This function is only called by Graphics Console module and GraphicsLib. \r
+  EDK II provides a UEFI Graphics Console module. ECP provides a GraphicsLib \r
+  complying to UEFI HII.\r
+  \r
+  This function will ASSERT and return EFI_UNSUPPORTED.\r
+\r
+  @param This            N.A.\r
+  @param GlyphBuffer     N.A.\r
+  @param Foreground      N.A.\r
+  @param Background      N.A.\r
+  @param Count           N.A.\r
+  @param Width           N.A.\r
+  @param Height          N.A.\r
+  @param BltBuffer       N.A.\r
+\r
+  @return EFI_UNSUPPORTED N.A.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 HiiGlyphToBlt (\r