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 4ca50d56f857d96a20272d8549de1b98cf028696..4efa515d0862ccfeda0589438469d9ab6f1dac8e 100644 (file)
--- a/MdePkg/Include/Protocol/UnicodeCollation.h
+++ b/MdePkg/Include/Protocol/UnicodeCollation.h
@@ -67,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
@@ -88,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
@@ -104,8 +102,7 @@ VOID
 (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
@@ -120,8 +117,7 @@ VOID
 (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
@@ -142,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
@@ -167,47 +162,13 @@ BOOLEAN
   IN CHAR16                                 *String,\r
   IN UINTN                                  FatSize,\r
   OUT CHAR8                                 *Fat\r
-  )\r
-;\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
+///\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
@@ -218,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