Reviewed the description of ECP in the .dec file for clarity and completeness, and...

[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / Include / Library / LanguageLib.h

diff --git a/EdkCompatibilityPkg/Compatibility/Include/Library/LanguageLib.h b/EdkCompatibilityPkg/Compatibility/Include/Library/LanguageLib.h
index cc9a5d36eaae3cf26f48edf13625aa9a6d9e46f3..bb8c4c6c6dc1b31cd86f9fd01a470384f73f1a65 100644 (file)
--- a/EdkCompatibilityPkg/Compatibility/Include/Library/LanguageLib.h
+++ b/EdkCompatibilityPkg/Compatibility/Include/Library/LanguageLib.h
@@ -16,24 +16,24 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __LANGUAGE_LIB__\r
 \r
 /**\r
-  Convert an ISO 639-2 language code to a RFC 4646 language code.\r
-  If the ISO 639-2 language code has a corresponding ISO 639-1 code, then the ISO 639-1\r
-  code is returned. Else the original ISO 639-2 code is returned. The returned RFC 4646\r
+  Converts an ISO 639-2 language code to an RFC 4646 language code.\r
+  If the ISO 639-2 language code has a corresponding ISO 639-1 code, then that ISO 639-1\r
+  code is returned in the out parameter. Else the original ISO 639-2 code is returned. The returned RFC 4646\r
   language code is composed of only a primary language subtag.\r
 \r
-  If Iso639Language is NULL, then ASSERT.\r
-  If Rfc4646Language is NULL, then ASSERT.\r
+  If Iso639Language is NULL, then ASSERT().\r
+  If Rfc4646Language is NULL, then ASSERT().\r
 \r
   @param[out] Rfc4646Language  Pointers to a buffer large enough for an ASCII string\r
-                               which reprsents a RFC 4646 language code containging only\r
+                               representing an RFC 4646 language code containing only\r
                                either a ISO 639-1 or ISO 639-2 primary language subtag.\r
                                This string is Null-terminated.\r
-  @param[in]  Iso639Language   Pointer to a 3-letter ASCII string which represents\r
+  @param[in]  Iso639Language   Pointer to a 3-letter ASCII string that represents\r
                                an ISO 639-2 language code. This string is not required\r
                                to be Null-terminated.\r
 \r
-  @retval TRUE                 The ISO 639-2 language code was converted to a ISO 639-1 code.\r
-  @retval FALSE                The language code does not have corresponding ISO 639-1 code.\r
+  @retval TRUE                 The ISO 639-2 language code was converted to an ISO 639-1 code.\r
+  @retval FALSE                The language code does not have a corresponding ISO 639-1 code.\r
 \r
 **/\r
 BOOLEAN\r
@@ -44,16 +44,16 @@ ConvertIso639ToRfc4646 (
   );\r
 \r
 /**\r
-  Convert a RFC 4646 language code to an ISO 639-2 language code. The primary language\r
+  Converts an RFC 4646 language code to an ISO 639-2 language code. The primary language\r
   subtag of the RFC 4646 code must be either an ISO 639-1 or 639-2 code. If the primary\r
   language subtag is an ISO 639-1 code, then it is converted to its corresponding ISO 639-2\r
   code (T code if applies). Else the ISO 639-2 code is returned.\r
 \r
-  If Rfc4646Language is NULL, then ASSERT.\r
-  If Iso639Language is NULL, then ASSERT.\r
+  If Rfc4646Language is NULL, then ASSERT().\r
+  If Iso639Language is NULL, then ASSERT().\r
 \r
   @param[out] Iso639Language   Pointers to a buffer large enough for a 3-letter ASCII string\r
-                               which reprsents an ISO 639-2 language code. The string is Null-terminated.\r
+                               representing an ISO 639-2 language code. The string is Null-terminated.\r
   @param[in]  Rfc4646Language  Pointer to a RFC 4646 language code string. This string is terminated\r
                                by a NULL or a ';' character.\r
 \r
@@ -69,12 +69,12 @@ ConvertRfc4646ToIso639 (
   );\r
 \r
 /**\r
-  Convert ISO 639-2 language codes to RFC 4646 codes and return the converted codes.\r
+  Converts ISO 639-2 language codes to RFC 4646 codes and returns the converted codes.\r
   Caller is responsible for freeing the allocated buffer.\r
 \r
   If Iso639Languages is NULL, then ASSERT.\r
 \r
-  @param[in] Iso639Languages  Pointers to a Null-terminated ISO 639-2 language codes string containing\r
+  @param[in] Iso639Languages  Pointers to Null-terminated ISO 639-2 language code strings containing\r
                               one or more ISO 639-2 3-letter language codes.\r
   \r
   @retval NULL                Invalid ISO 639-2 language code found.\r
@@ -91,7 +91,7 @@ ConvertLanguagesIso639ToRfc4646 (
   );\r
 \r
 /**\r
-  Convert RFC 4646 language codes to ISO 639-2 codes and return the converted codes.\r
+  Converts RFC 4646 language codes to ISO 639-2 codes and returns the converted codes.\r
   The primary language subtag of the RFC 4646 code must be either an ISO 639-1 or 639-2 code.\r
   Caller is responsible for freeing the allocated buffer.\r
 \r