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

[mirror_edk2.git] / MdePkg / Include / Protocol / UnicodeCollation.h

diff --git a/MdePkg/Include/Protocol/UnicodeCollation.h b/MdePkg/Include/Protocol/UnicodeCollation.h
index f516bd4f88c1f8d9b6ba1da15eab2e4a004ee2ac..4ca50d56f857d96a20272d8549de1b98cf028696 100644 (file)
--- a/MdePkg/Include/Protocol/UnicodeCollation.h
+++ b/MdePkg/Include/Protocol/UnicodeCollation.h
@@ -1,7 +1,9 @@
 /** @file\r
   Unicode Collation protocol that follows the UEFI 2.0 specification.\r
+  This protocol is used to allow code running in the boot services environment \r
+  to perform lexical comparison functions on Unicode strings for given languages.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -28,19 +30,19 @@
 typedef struct _EFI_UNICODE_COLLATION_PROTOCOL  EFI_UNICODE_COLLATION_PROTOCOL;\r
 \r
 \r
-//\r
-// Protocol GUID name defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol GUID name defined in EFI1.1.\r
+/// \r
 #define UNICODE_COLLATION_PROTOCOL              EFI_UNICODE_COLLATION_PROTOCOL_GUID\r
 \r
-//\r
-// Protocol defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol defined in EFI1.1.\r
+/// \r
 typedef EFI_UNICODE_COLLATION_PROTOCOL          UNICODE_COLLATION_INTERFACE;\r
 \r
-//\r
-// Protocol data structures and defines\r
-//\r
+///\r
+/// Protocol data structures and defines\r
+///\r
 #define EFI_UNICODE_BYTE_ORDER_MARK (CHAR16) (0xfeff)\r
 \r
 //\r
@@ -61,7 +63,7 @@ typedef EFI_UNICODE_COLLATION_PROTOCOL          UNICODE_COLLATION_INTERFACE;
 **/\r
 typedef\r
 INTN\r
-(EFIAPI *EFI_UNICODE_COLLATION_STRICOLL) (\r
+(EFIAPI *EFI_UNICODE_COLLATION_STRICOLL)(\r
   IN EFI_UNICODE_COLLATION_PROTOCOL         *This,\r
   IN CHAR16                                 *Str1,\r
   IN CHAR16                                 *Str2\r
@@ -82,7 +84,7 @@ INTN
 **/\r
 typedef\r
 BOOLEAN\r
-(EFIAPI *EFI_UNICODE_COLLATION_METAIMATCH) (\r
+(EFIAPI *EFI_UNICODE_COLLATION_METAIMATCH)(\r
   IN EFI_UNICODE_COLLATION_PROTOCOL         *This,\r
   IN CHAR16                                 *String,\r
   IN CHAR16                                 *Pattern\r
@@ -96,12 +98,10 @@ BOOLEAN
   @param  This   Protocol instance pointer.\r
   @param  String A pointer to a Null-terminated Unicode string.\r
 \r
-  NONE\r
-\r
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_UNICODE_COLLATION_STRLWR) (\r
+(EFIAPI *EFI_UNICODE_COLLATION_STRLWR)(\r
   IN EFI_UNICODE_COLLATION_PROTOCOL         *This,\r
   IN OUT CHAR16                             *Str\r
   )\r
@@ -114,12 +114,10 @@ VOID
   @param  This   Protocol instance pointer.\r
   @param  String A pointer to a Null-terminated Unicode string.\r
 \r
-  NONE\r
-\r
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_UNICODE_COLLATION_STRUPR) (\r
+(EFIAPI *EFI_UNICODE_COLLATION_STRUPR)(\r
   IN EFI_UNICODE_COLLATION_PROTOCOL         *This,\r
   IN OUT CHAR16                             *Str\r
   )\r
@@ -136,12 +134,10 @@ VOID
   @param  String  A pointer to a Null-terminated Unicode string. The string must\r
                   be preallocated to hold FatSize Unicode characters.\r
 \r
-  NONE\r
-\r
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_UNICODE_COLLATION_FATTOSTR) (\r
+(EFIAPI *EFI_UNICODE_COLLATION_FATTOSTR)(\r
   IN EFI_UNICODE_COLLATION_PROTOCOL         *This,\r
   IN UINTN                                  FatSize,\r
   IN CHAR8                                  *Fat,\r
@@ -166,7 +162,7 @@ VOID
 **/\r
 typedef\r
 BOOLEAN\r
-(EFIAPI *EFI_UNICODE_COLLATION_STRTOFAT) (\r
+(EFIAPI *EFI_UNICODE_COLLATION_STRTOFAT)(\r
   IN EFI_UNICODE_COLLATION_PROTOCOL         *This,\r
   IN CHAR16                                 *String,\r
   IN UINTN                                  FatSize,\r
@@ -174,6 +170,40 @@ BOOLEAN
   )\r
 ;\r
 \r
+/**  \r
+  @par Protocol Description:\r
+  The EFI_UNICODE_COLLATION_PROTOCOL is used to perform case-insensitive \r
+  comparisons of Unicode strings. \r
+\r
+  @param StriColl\r
+  Performs a case-insensitive comparison of two Null-terminated Unicode strings. \r
+\r
+  @param MetaiMatch\r
+  Performs a case-insensitive comparison between a Null-terminated Unicode \r
+  pattern string and a Null-terminated Unicode string. The pattern string \r
+  can use the '?' wildcard to match any character, and the '*' wildcard to \r
+  match any substring. \r
+\r
+  @param StrLwr\r
+  Converts all the Unicode characters in a Null-terminated Unicode string to \r
+  lowercase Unicode characters. \r
+\r
+  @param StrUpr\r
+  Converts all the Unicode characters in a Null-terminated Unicode string to \r
+  uppercase Unicode characters. \r
+\r
+  @param FatToStr\r
+  Converts an 8.3 FAT file name using an OEM character set to a Null-terminated \r
+  Unicode string. \r
+\r
+  @param StrToFat\r
+  Converts a Null-terminated Unicode string to legal characters in a FAT \r
+  filename using an OEM character set. \r
+\r
+  @param Supported\r
+  LanguagesA Null-terminated ASCII string array that contains one or more \r
+  language codes. This array is specified in RFC 4646 format.\r
+**/\r
 struct _EFI_UNICODE_COLLATION_PROTOCOL {\r
   //\r
   // general\r