Add doxygen style comments for functions in English module.

[mirror_edk2.git] / MdeModulePkg / Universal / Disk / UnicodeCollation / EnglishDxe / UnicodeCollationEng.h

diff --git a/MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.h b/MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.h
index 74e243c424b8ab269718d8956d1df445751f8db0..7cab7088cf3e05a5d28cd1b455ce6dca523c6193 100644 (file)
--- a/MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.h
+++ b/MdeModulePkg/Universal/Disk/UnicodeCollation/EnglishDxe/UnicodeCollationEng.h
@@ -38,15 +38,40 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //\r
 // Prototypes\r
 //\r
+/**\r
+  Performs a case-insensitive comparison of two Null-terminated Unicode \r
+  strings.\r
+\r
+  @param  This Protocol instance pointer.\r
+  @param  Str1 A pointer to a Null-terminated Unicode string.\r
+  @param  Str2 A pointer to a Null-terminated Unicode string.\r
+\r
+  @retval 0   Str1 is equivalent to Str2\r
+  @retval > 0 Str1 is lexically greater than Str2\r
+  @retval < 0 Str1 is lexically less than Str2\r
+\r
+**/\r
 INTN\r
 EFIAPI\r
 EngStriColl (\r
   IN EFI_UNICODE_COLLATION_PROTOCOL           *This,\r
-  IN CHAR16                                   *s1,\r
-  IN CHAR16                                   *s2\r
+  IN CHAR16                                   *Str1,\r
+  IN CHAR16                                   *Str2\r
   )\r
 ;\r
 \r
+/**\r
+  Performs a case-insensitive comparison of a Null-terminated Unicode \r
+  pattern string and a Null-terminated Unicode string.\r
+\r
+  @param  This    Protocol instance pointer.\r
+  @param  String  A pointer to a Null-terminated Unicode string.\r
+  @param  Pattern A pointer to a Null-terminated Unicode pattern string.\r
+\r
+  @retval TRUE    Pattern was found in String.\r
+  @retval FALSE   Pattern was not found in String.\r
+\r
+**/\r
 BOOLEAN\r
 EFIAPI\r
 EngMetaiMatch (\r
@@ -56,6 +81,14 @@ EngMetaiMatch (
   )\r
 ;\r
 \r
+/**\r
+  Converts all the Unicode characters in a Null-terminated Unicode string to \r
+  lower case Unicode characters.\r
+\r
+  @param  This   Protocol instance pointer.\r
+  @param  Str    A pointer to a Null-terminated Unicode string.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 EngStrLwr (\r
@@ -64,6 +97,14 @@ EngStrLwr (
   )\r
 ;\r
 \r
+/**\r
+  Converts all the Unicode characters in a Null-terminated Unicode string to upper\r
+  case Unicode characters.\r
+\r
+  @param  This   Protocol instance pointer.\r
+  @param  Str    A pointer to a Null-terminated Unicode string.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 EngStrUpr (\r
@@ -72,6 +113,18 @@ EngStrUpr (
   )\r
 ;\r
 \r
+/**\r
+  Converts an 8.3 FAT file name in an OEM character set to a Null-terminated \r
+  Unicode string.\r
+\r
+  @param  This    Protocol instance pointer.\r
+  @param  FatSize The size of the string Fat in bytes.\r
+  @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
+                  name using an OEM character set.\r
+  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
+                  be preallocated to hold FatSize Unicode characters.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 EngFatToStr (\r
@@ -82,6 +135,21 @@ EngFatToStr (
   )\r
 ;\r
 \r
+/**\r
+  Converts a Null-terminated Unicode string to legal characters in a FAT \r
+  filename using an OEM character set. \r
+\r
+  @param  This    Protocol instance pointer.\r
+  @param  String  A pointer to a Null-terminated Unicode string. The string must\r
+                  be preallocated to hold FatSize Unicode characters.\r
+  @param  FatSize The size of the string Fat in bytes.\r
+  @param  Fat     A pointer to a Null-terminated string that contains an 8.3 file\r
+                  name using an OEM character set.\r
+\r
+  @retval TRUE    Fat is a Long File Name\r
+  @retval FALSE   Fat is an 8.3 file name\r
+\r
+**/\r
 BOOLEAN\r
 EFIAPI\r
 EngStrToFat (\r
@@ -92,6 +160,19 @@ EngStrToFat (
   )\r
 ;\r
 \r
+/**\r
+  The user Entry Point for English module.\r
+ \r
+  This function initializes unicode character mapping and then installs Unicode\r
+  Collation & Unicode Collation 2 Protocols based on the feature flags.  \r
+\r
+  @param  ImageHandle    The firmware allocated handle for the EFI image.  \r
+  @param  SystemTable    A pointer to the EFI System Table.\r
+  \r
+  @retval EFI_SUCCESS    The entry point is executed successfully.\r
+  @retval other          Some error occurs when executing this entry point.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 InitializeUnicodeCollationEng (\r