Clean up HiiDatabase for Doxygen comments requirement.

[mirror_edk2.git] / MdeModulePkg / Universal / HiiDatabaseDxe / HiiDatabase.h

diff --git a/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h b/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h
index bbd366edece9c1f84654e514d9d14142b02311ef..ac88b86d077d68b2b1a14a4a8f13fe466ce7d461 100644 (file)
--- a/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h
+++ b/MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h
@@ -1,4 +1,5 @@
 /** @file\r
+Private structures definitions in HiiDatabase.\r
 \r
 Copyright (c) 2007 - 2008, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
@@ -9,17 +10,6 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-Module Name:\r
-\r
-    HiiDatabase.h\r
-\r
-Abstract:\r
-\r
-    Private structures definitions in HiiDatabase.\r
-\r
-Revision History\r
-\r
-\r
 **/\r
 \r
 #ifndef __HII_DATABASE_PRIVATE_H__\r
@@ -251,7 +241,7 @@ typedef struct _HII_DATABASE_PRIVATE_DATA {
   LIST_ENTRY                            DatabaseList;\r
   LIST_ENTRY                            DatabaseNotifyList;\r
   EFI_HII_FONT_PROTOCOL                 HiiFont;\r
-#ifndef DISABLE_UNUSED_HII_PROTOCOLS\r
+#ifndef _DISABLE_UNUSED_HII_PROTOCOLS_\r
   EFI_HII_IMAGE_PROTOCOL                HiiImage;\r
 #endif\r
   EFI_HII_STRING_PROTOCOL               HiiString;\r
@@ -305,7 +295,7 @@ typedef struct _HII_DATABASE_PRIVATE_DATA {
 //\r
 \r
 /**\r
-  This function checks whether a handle is a valid EFI_HII_HANDLE\r
+  This function checks whether a handle is a valid EFI_HII_HANDLE.\r
 \r
   @param  Handle                  Pointer to a EFI_HII_HANDLE\r
 \r
@@ -470,7 +460,10 @@ FindGlyphBlock (
                                   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  BltX,BLTY               Specifies the offset from the left and top edge\r
+  @param  BltX                    Together with BltX, Specifies the offset from the left and top edge\r
+                                  of the image of the first character cell in the\r
+                                  image.\r
+  @param  BltY                    Together with BltY, Specifies the offset from the left and top edge\r
                                   of the image of the first character cell in the\r
                                   image.\r
   @param  RowInfoArray            If this is non-NULL on entry, then on exit, this\r
@@ -543,7 +536,10 @@ HiiStringToImage (
                                   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  BltX,BLTY               Specifies the offset from the left and top edge\r
+  @param  BltX                    Together with BltX, Specifies the offset from the left and top edge\r
+                                  of the image of the first character cell in the\r
+                                  image.\r
+  @param  BltY                    Together with BltY, Specifies the offset from the left and top edge\r
                                   of the image of the first character cell in the\r
                                   image.\r
   @param  RowInfoArray            If this is non-NULL on entry, then on exit, this\r
@@ -622,7 +618,7 @@ EFIAPI
 HiiGetGlyph (\r
   IN  CONST EFI_HII_FONT_PROTOCOL    *This,\r
   IN  CHAR16                         Char,\r
-  IN  CONST EFI_FONT_DISPLAY_INFO    *StringInfo, OPTIONAL\r
+  IN  CONST EFI_FONT_DISPLAY_INFO    *StringInfo,\r
   OUT EFI_IMAGE_OUTPUT               **Blt,\r
   OUT UINTN                          *Baseline OPTIONAL\r
   )\r
@@ -663,7 +659,7 @@ EFIAPI
 HiiGetFontInfo (\r
   IN  CONST EFI_HII_FONT_PROTOCOL    *This,\r
   IN  OUT   EFI_FONT_HANDLE          *FontHandle,\r
-  IN  CONST EFI_FONT_DISPLAY_INFO    *StringInfoIn,\r
+  IN  CONST EFI_FONT_DISPLAY_INFO    *StringInfoIn, OPTIONAL\r
   OUT       EFI_FONT_DISPLAY_INFO    **StringInfoOut,\r
   IN  CONST EFI_STRING               String OPTIONAL\r
   )\r
@@ -778,6 +774,9 @@ HiiSetImage (
                                   a buffer will be allocated to hold  the generated\r
                                   image and the pointer updated on exit. It is the\r
                                   caller's responsibility to free this buffer.\r
+  @param  BltX                    Specifies the offset from the left and top edge\r
+                                  of the  output image of the first pixel in the\r
+                                  image.\r
   @param  BltY                    Specifies the offset from the left and top edge\r
                                   of the  output image of the first pixel in the\r
                                   image.\r
@@ -821,6 +820,9 @@ HiiDrawImage (
                                   allocated to hold  the generated image and the\r
                                   pointer updated on exit. It is the caller's\r
                                   responsibility to free this buffer.\r
+  @param  BltX                    Specifies the offset from the left and top edge\r
+                                  of the  output image of the first pixel in the\r
+                                  image.\r
   @param  BltY                    Specifies the offset from the left and top edge\r
                                   of the  output image of the first pixel in the\r
                                   image.\r
@@ -1025,7 +1027,7 @@ HiiGetLanguages (
                                   FirstLanguage. If there are no secondary\r
                                   languages, the function  returns successfully,\r
                                   but this is set to NULL.\r
-  @param  SecondaryLanguageSize   On entry, points to the size of the buffer\r
+  @param  SecondaryLanguagesSize  On entry, points to the size of the buffer\r
                                   pointed to  by SecondLanguages, in bytes. On\r
                                   return, points to the length of SecondLanguages\r
                                   in bytes.\r
@@ -1048,8 +1050,8 @@ HiiGetSecondaryLanguages (
   IN CONST EFI_HII_STRING_PROTOCOL   *This,\r
   IN EFI_HII_HANDLE                  PackageList,\r
   IN CONST CHAR8                     *FirstLanguage,\r
-  IN OUT CHAR8                       *SecondLanguages,\r
-  IN OUT UINTN                       *SecondLanguagesSize\r
+  IN OUT CHAR8                       *SecondaryLanguages,\r
+  IN OUT UINTN                       *SecondaryLanguagesSize\r
   )\r
 ;\r
 \r
@@ -1278,7 +1280,7 @@ HiiRegisterPackageNotify (
 \r
   @param  This                    A pointer to the EFI_HII_DATABASE_PROTOCOL\r
                                   instance.\r
-  @param  NotifyHandle            The handle of the notification function being\r
+  @param  NotificationHandle      The handle of the notification function being\r
                                   unregistered.\r
 \r
   @retval EFI_SUCCESS             Notification is unregistered successfully.\r