Use doxygen comment style for document entity such as struct, enum, variable that...

[mirror_edk2.git] / MdePkg / Include / Library / HiiLib.h

diff --git a/MdePkg/Include/Library/HiiLib.h b/MdePkg/Include/Library/HiiLib.h
index 806be1fb65665d5c5022a80a28c3a7c6e1cb4e4b..33bcf30a215d0e9f43fcbbecf4c6c03641874681 100644 (file)
--- a/MdePkg/Include/Library/HiiLib.h
+++ b/MdePkg/Include/Library/HiiLib.h
@@ -57,14 +57,14 @@ HiiLibPreparePackageList (
 \r
   If HiiHandle is NULL, then ASSERT.\r
 \r
-  @param  NumberOfPackages  The number of HII packages to register.\r
-  @param  GuidId                    Package List GUID ID.\r
-  @param  EFI_HANDLE            Optional. If not NULL, the DriverHandle on which an instance of DEVICE_PATH_PROTOCOL is installed.\r
-                                             This DriverHandle uniquely defines the device that the added packages are associated with.\r
-  @param  HiiHandle                On output, the HiiHandle is update with the handle which can be used to retrieve the Package \r
-                                             List later. If the functions failed to add the package to the default HII database, this value will\r
-                                             be set to NULL.\r
-  @param  ...                          The variable argument list describing all HII Package.\r
+  @param  NumberOfPackages    The number of HII packages to register.\r
+  @param  GuidId              Package List GUID ID.\r
+  @param  DriverHandle        Optional. If not NULL, the DriverHandle on which an instance of DEVICE_PATH_PROTOCOL is installed.\r
+                              This DriverHandle uniquely defines the device that the added packages are associated with.\r
+  @param  HiiHandle           On output, the HiiHandle is update with the handle which can be used to retrieve the Package \r
+                              List later. If the functions failed to add the package to the default HII database, this value will\r
+                              be set to NULL.\r
+  @param  ...                 The variable argument list describing all HII Package.\r
 \r
   @return  EFI_SUCCESS         If the packages are successfully added to the default HII database.\r
   @return  EFI_OUT_OF_RESOURCE Not enough resource to complete the operation.\r
@@ -90,8 +90,6 @@ HiiLibAddPackages (
   @param  HiiHandle                The handle that was previously registered to the data base that is requested for removal.\r
                                              List later.\r
 \r
-  @return  VOID\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -175,10 +173,8 @@ HiiLibSetString (
   @retval EFI_NOT_FOUND          The string specified by StringId is not available.\r
   @retval EFI_BUFFER_TOO_SMALL   The buffer specified by StringLength is too small\r
                                  to hold the string.\r
-  @retval EFI_INVALID_PARAMETER  The String or StringSize was NULL.\r
 \r
 **/\r
-\r
 EFI_STATUS\r
 EFIAPI\r
 HiiLibGetString (\r
@@ -248,8 +244,6 @@ HiiLibGetStringFromToken (
   If HandleBufferLength is NULL, then ASSERT.\r
   If HiiHandleBuffer is NULL, then ASSERT.\r
 \r
-  @param  HiiDatabase            A pointer to the EFI_HII_DATABASE_PROTOCOL\r
-                                 instance.\r
   @param  HandleBufferLength     On input, a pointer to the length of the handle\r
                                  buffer. On output, the length of the handle buffer\r
                                  that is required for the handles found.\r
@@ -272,8 +266,8 @@ HiiLibGetHiiHandles (
   If HiiHandle could not be found in the default HII database, then ASSERT.\r
   If Guid is NULL, then ASSERT.\r
 \r
-  @param  HiiHandle              Hii handle\r
-  @param  Guid                   Package list GUID\r
+  @param  Handle              Hii handle\r
+  @param  Guid                Package list GUID\r
 \r
   @retval EFI_SUCCESS            Successfully extract GUID from Hii database.\r
 \r
@@ -354,11 +348,11 @@ HiiLibGetNextLanguage (
   in UEFI specification Appendix M.\r
 \r
   If HiiHandle is not a valid Handle in the default HII database, then ASSERT.\r
-  If not enough resource to complete the operation, then ASSERT.\r
 \r
   @param  HiiHandle              The HII package list handle.\r
 \r
-  @return The supported languages.\r
+  @retval   !NULL  The supported languages.\r
+  @retval   NULL    If Supported Languages can not be retrived.\r
 \r
 **/\r
 CHAR8 *\r
@@ -368,6 +362,28 @@ HiiLibGetSupportedLanguages (
   )\r
 ;\r
 \r
+/**\r
+  This function returns the list of supported 2nd languages, in the format specified\r
+  in UEFI specification Appendix M.\r
+\r
+  If HiiHandle is not a valid Handle in the default HII database, then ASSERT.\r
+  If not enough resource to complete the operation, then ASSERT.\r
+\r
+  @param  HiiHandle              The HII package list handle.\r
+  @param  FirstLanguage          Pointer to language name buffer.\r
+  \r
+  @return The supported languages.\r
+\r
+**/\r
+CHAR8 *\r
+EFIAPI\r
+HiiLibGetSupportedSecondaryLanguages (\r
+  IN EFI_HII_HANDLE           HiiHandle,\r
+  IN CONST CHAR8              *FirstLanguage\r
+  )\r
+;\r
+\r
+\r
 /**\r
   This function returns the number of supported languages on HiiHandle.\r
 \r
@@ -389,6 +405,12 @@ HiiLibGetSupportedLanguageNumber (
 /**\r
   Convert language code from RFC3066 to ISO639-2.\r
 \r
+  LanguageRfc3066 contain a single RFC 3066 code such as\r
+  "en-US" or "fr-FR".\r
+\r
+  The LanguageRfc3066 must be a buffer large enough\r
+  for ISO_639_2_ENTRY_SIZE characters.\r
+\r
   If LanguageRfc3066 is NULL, then ASSERT.\r
   If LanguageIso639 is NULL, then ASSERT.\r
 \r
@@ -402,8 +424,35 @@ HiiLibGetSupportedLanguageNumber (
 EFI_STATUS\r
 EFIAPI\r
 ConvertRfc3066LanguageToIso639Language (\r
-  CHAR8   *LanguageRfc3066,\r
-  CHAR8   *LanguageIso639\r
+  IN  CHAR8   *LanguageRfc3066,\r
+  OUT CHAR8   *LanguageIso639\r
+  )\r
+;\r
+\r
+/**\r
+  Convert language code from ISO639-2 to RFC3066.\r
+\r
+  LanguageIso639 contain a single ISO639-2 code such as\r
+  "eng" or "fra".\r
+\r
+  The LanguageRfc3066 must be a buffer large enough\r
+  for RFC_3066_ENTRY_SIZE characters.\r
+\r
+  If LanguageIso639 is NULL, then ASSERT.\r
+  If LanguageRfc3066 is NULL, then ASSERT.\r
+\r
+  @param  LanguageIso639         ISO639-2 language code.\r
+  @param  LanguageRfc3066        RFC3066 language code.\r
+\r
+  @retval EFI_SUCCESS            Language code converted.\r
+  @retval EFI_NOT_FOUND          Language code not found.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ConvertIso639LanguageToRfc3066Language (\r
+  IN  CONST CHAR8   *LanguageIso639,\r
+  OUT CHAR8         *LanguageRfc3066\r
   )\r
 ;\r
 \r