Update comments for Protocol definitions to match UEFI spec.

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

diff --git a/MdePkg/Include/Protocol/UnicodeCollation.h b/MdePkg/Include/Protocol/UnicodeCollation.h
index f666d13185294c8459b3e7198552b183b4b220c4..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 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
@@ -65,8 +67,7 @@ INTN
   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
@@ -86,8 +87,7 @@ BOOLEAN
   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
@@ -96,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
   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
@@ -114,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
   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
@@ -136,8 +130,6 @@ 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
@@ -146,8 +138,7 @@ VOID
   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
@@ -171,13 +162,13 @@ BOOLEAN
   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
@@ -188,7 +179,11 @@ 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