idn2_to_ascii: clarified documentation on default flags [ci skip]

parent 3d012a66
Pipeline #19278578 skipped
......@@ -558,8 +558,11 @@ idn2_lookup_ul (const char * src, char ** lookupname, int flags)
* range to begin with (although it could fail). Applying the ToASCII operation multiple
* effect as applying it just once.
*
* When unsure, it is recommended to call this function with the
* %IDN2_NONTRANSITIONAL and %IDN2_NFC_INPUT flags.
* The default behavior of this function (when flags are zero) is to apply
* the IDNA2008 rules without the TR46 amendments. As the TR46
* non-transitional processing is nowdays ubiquitous, when unsure, it is
* recommended to to call this function with the %IDN2_NONTRANSITIONAL
* and the %IDN2_NFC_INPUT flags for compatibility with other software.
*
* Return value: Returns %IDN2_OK on success, or error code.
*
......@@ -623,8 +626,11 @@ idn2_to_ascii_4i (const uint32_t * input, size_t inlen, char * output, int flags
* rules. The domain name may contain several labels, separated by dots.
* The output buffer must be deallocated by the caller.
*
* When unsure, it is recommended to call this function with the
* %IDN2_NONTRANSITIONAL and %IDN2_NFC_INPUT flags.
* The default behavior of this function (when flags are zero) is to apply
* the IDNA2008 rules without the TR46 amendments. As the TR46
* non-transitional processing is nowdays ubiquitous, when unsure, it is
* recommended to to call this function with the %IDN2_NONTRANSITIONAL
* and the %IDN2_NFC_INPUT flags for compatibility with other software.
*
* Return value: Returns %IDN2_OK on success, or error code.
*
......@@ -668,8 +674,11 @@ idn2_to_ascii_4z (const uint32_t * input, char ** output, int flags)
* rules. The domain name may contain several labels, separated by dots.
* The output buffer must be deallocated by the caller.
*
* When unsure, it is recommended to call this function with the
* %IDN2_NONTRANSITIONAL and %IDN2_NFC_INPUT flags.
* The default behavior of this function (when flags are zero) is to apply
* the IDNA2008 rules without the TR46 amendments. As the TR46
* non-transitional processing is nowdays ubiquitous, when unsure, it is
* recommended to to call this function with the %IDN2_NONTRANSITIONAL
* and the %IDN2_NFC_INPUT flags for compatibility with other software.
*
* Return value: Returns %IDN2_OK on success, or error code.
*
......@@ -691,8 +700,11 @@ idn2_to_ascii_8z (const char * input, char ** output, int flags)
* rules. The domain name may contain several labels, separated by dots.
* The output buffer must be deallocated by the caller.
*
* When unsure, it is recommended to call this function with the
* %IDN2_NONTRANSITIONAL and %IDN2_NFC_INPUT flags.
* The default behavior of this function (when flags are zero) is to apply
* the IDNA2008 rules without the TR46 amendments. As the TR46
* non-transitional processing is nowdays ubiquitous, when unsure, it is
* recommended to to call this function with the %IDN2_NONTRANSITIONAL
* and the %IDN2_NFC_INPUT flags for compatibility with other software.
*
* Returns: %IDN2_OK on success, or error code.
* Same as described in idn2_lookup_ul() documentation.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment