Adjust doxygen comment style for structure.

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

diff --git a/MdePkg/Include/Protocol/UnicodeCollation.h b/MdePkg/Include/Protocol/UnicodeCollation.h
index e0278038f776ad1717017b635c5e89a8aecd09e6..4efa515d0862ccfeda0589438469d9ab6f1dac8e 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 EFI 1.0 specification.\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
@@ -10,8 +12,6 @@
   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:  UnicodeCollation.h\r
-\r
 **/\r
 \r
 #ifndef __UNICODE_COLLATION_H__\r
@@ -22,11 +22,27 @@
     0x1d85cd7f, 0xf43d, 0x11d2, {0x9a, 0xc, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
   }\r
 \r
-typedef struct _EFI_UNICODE_COLLATION_PROTOCOL   EFI_UNICODE_COLLATION_PROTOCOL;\r
+#define EFI_UNICODE_COLLATION_PROTOCOL2_GUID \\r
+  { \\r
+    0xa4c751fc, 0x23ae, 0x4c3e, {0x92, 0xe9, 0x49, 0x64, 0xcf, 0x63, 0xf3, 0x49 } \\r
+  }\r
 \r
-//\r
-// Protocol data structures and defines\r
-//\r
+typedef struct _EFI_UNICODE_COLLATION_PROTOCOL  EFI_UNICODE_COLLATION_PROTOCOL;\r
+\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
+typedef EFI_UNICODE_COLLATION_PROTOCOL          UNICODE_COLLATION_INTERFACE;\r
+\r
+///\r
+/// Protocol data structures and defines\r
+///\r
 #define EFI_UNICODE_BYTE_ORDER_MARK (CHAR16) (0xfeff)\r
 \r
 //\r
@@ -47,12 +63,11 @@ typedef struct _EFI_UNICODE_COLLATION_PROTOCOL   EFI_UNICODE_COLLATION_PROTOCOL;
 **/\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
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Performs a case-insensitive comparison of a Null-terminated Unicode \r
@@ -68,12 +83,11 @@ 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
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Converts all the Unicode characters in a Null-terminated Unicode string to \r
@@ -82,16 +96,13 @@ 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
-;\r
+  );\r
 \r
 /**\r
   Converts all the Unicode characters in a Null-terminated Unicode string to upper\r
@@ -100,16 +111,13 @@ 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
-;\r
+  );\r
 \r
 /**\r
   Converts an 8.3 FAT file name in an OEM character set to a Null-terminated \r
@@ -122,18 +130,15 @@ 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
   OUT CHAR16                                *String\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Converts a Null-terminated Unicode string to legal characters in a FAT \r
@@ -152,18 +157,18 @@ 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
   OUT CHAR8                                 *Fat\r
-  )\r
-;\r
+  );\r
 \r
+///\r
+/// The EFI_UNICODE_COLLATION_PROTOCOL is used to perform case-insensitive \r
+/// comparisons of Unicode strings. \r
+///\r
 struct _EFI_UNICODE_COLLATION_PROTOCOL {\r
-  //\r
-  // general\r
-  //\r
   EFI_UNICODE_COLLATION_STRICOLL    StriColl;\r
   EFI_UNICODE_COLLATION_METAIMATCH  MetaiMatch;\r
   EFI_UNICODE_COLLATION_STRLWR      StrLwr;\r
@@ -174,10 +179,15 @@ struct _EFI_UNICODE_COLLATION_PROTOCOL {
   //\r
   EFI_UNICODE_COLLATION_FATTOSTR    FatToStr;\r
   EFI_UNICODE_COLLATION_STRTOFAT    StrToFat;\r
-\r
+  \r
+  ///\r
+  /// A Null-terminated ASCII string array that contains one or more \r
+  /// language codes. This array is specified in RFC 4646 format.\r
+  ///\r
   CHAR8                             *SupportedLanguages;\r
 };\r
 \r
 extern EFI_GUID gEfiUnicodeCollationProtocolGuid;\r
+extern EFI_GUID gEfiUnicodeCollation2ProtocolGuid;\r
 \r
 #endif\r