From 61e334303b59d28e0baa1737a5e5751aad301e32 Mon Sep 17 00:00:00 2001
From: qhuang8 <qhuang8@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Thu, 8 May 2008 03:10:39 +0000
Subject: Add doxygen style comments for functions in English module.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5179 6f19259b-4bc3-4df7-8a09-765794883524
---
 .../EnglishDxe/UnicodeCollationEng.h               | 85 +++++++++++++++++++++-
 1 file changed, 83 insertions(+), 2 deletions(-)

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