doc: document the idn2_flags in functions using them

parent 5d807ab5
Pipeline #10687353 passed with stages
in 6 minutes 56 seconds
......@@ -43,7 +43,7 @@
* idn2_to_unicode_8z4z:
* @input: Input zero-terminated UTF-8 string.
* @output: Newly allocated UTF-32/UCS-4 output string.
* @flags: Currently unused.
* @flags: optional #idn2_flags to modify behaviour.
*
* Converts a possibly ACE encoded domain name in UTF-8 format into a
* UTF-32 string (punycode decoding). The output buffer will be zero-terminated
......@@ -160,7 +160,7 @@ idn2_to_unicode_8z4z (const char * input, uint32_t ** output, G_GNUC_UNUSED int
* idn2_to_unicode_4z4z:
* @input: Input zero-terminated UTF-32 string.
* @output: Newly allocated UTF-32 output string.
* @flags: Currently unused.
* @flags: optional #idn2_flags to modify behaviour.
*
* Converts a possibly ACE encoded domain name in UTF-32 format into a
* UTF-32 string (punycode decoding). The output buffer will be zero-terminated
......@@ -221,7 +221,7 @@ idn2_to_unicode_4z4z (const uint32_t * input, uint32_t ** output, int flags)
* @out: output array with UTF-32 code points.
* @outlen: on input, maximum size of output array with UTF-32 code points,
* on exit, actual size of output array with UTF-32 code points.
* @flags: Currently unused.
* @flags: optional #idn2_flags to modify behaviour.
*
* The ToUnicode operation takes a sequence of UTF-32 code points
* that make up one domain label and returns a sequence of UTF-32
......@@ -282,7 +282,7 @@ idn2_to_unicode_44i (const uint32_t * in, size_t inlen, uint32_t * out, size_t *
* idn2_to_unicode_8z8z:
* @input: Input zero-terminated UTF-8 string.
* @output: Newly allocated UTF-8 output string.
* @flags: Currently unused.
* @flags: optional #idn2_flags to modify behaviour.
*
* Converts a possibly ACE encoded domain name in UTF-8 format into a
* UTF-8 string (punycode decoding). The output buffer will be zero-terminated
......@@ -333,7 +333,7 @@ idn2_to_unicode_8z8z (const char * input, char ** output, int flags)
* idn2_to_unicode_8zlz:
* @input: Input zero-terminated UTF-8 string.
* @output: Newly allocated output string in current locale's character set.
* @flags: Currently unused.
* @flags: optional #idn2_flags to modify behaviour.
*
* Converts a possibly ACE encoded domain name in UTF-8 format into a
* string encoded in the current locale's character set (punycode
......@@ -376,7 +376,7 @@ idn2_to_unicode_8zlz (const char * input, char ** output, int flags)
* idn2_to_unicode_lzlz:
* @input: Input zero-terminated string encoded in the current locale's character set.
* @output: Newly allocated output string in current locale's character set.
* @flags: Currently unused.
* @flags: optional #idn2_flags to modify behaviour.
*
* Converts a possibly ACE encoded domain name in the locale's character
* set into a string encoded in the current locale's character set (punycode
......
......@@ -533,7 +533,7 @@ idn2_lookup_ul (const char * src, char ** lookupname, int flags)
* @input: zero terminated input Unicode (UCS-4) string.
* @inlen: number of elements in @input.
* @output: pointer to newly allocated zero-terminated output string.
* @flags: are ignored.
* @flags: optional #idn2_flags to modify behaviour.
*
* The ToASCII operation takes a sequence of Unicode code points that make
* up one domain label and transforms it into a sequence of code points in
......@@ -611,7 +611,7 @@ idn2_to_ascii_4i (const uint32_t * input, size_t inlen, char * output, int flags
* idn2_to_ascii_4z:
* @input: zero terminated input Unicode (UCS-4) string.
* @output: pointer to newly allocated zero-terminated output string.
* @flags: are ignored
* @flags: optional #idn2_flags to modify behaviour.
*
* Convert UCS-4 domain name to ASCII string using the IDNA2008
* rules. The domain name may contain several labels, separated by dots.
......@@ -656,7 +656,7 @@ idn2_to_ascii_4z (const uint32_t * input, char ** output, int flags)
* idn2_to_ascii_8z:
* @input: zero terminated input UTF-8 string.
* @output: pointer to newly allocated output string.
* @flags: are ignored
* @flags: optional #idn2_flags to modify behaviour.
*
* Convert UTF-8 domain name to ASCII string using the IDNA2008
* rules. The domain name may contain several labels, separated by dots.
......@@ -679,7 +679,7 @@ idn2_to_ascii_8z (const char * input, char ** output, int flags)
* idn2_to_ascii_lz:
* @input: zero terminated input UTF-8 string.
* @output: pointer to newly allocated output string.
* @flags: are ignored
* @flags: optional #idn2_flags to modify behaviour.
*
* Convert a domain name in locale's encoding to ASCII string using the IDNA2008
* rules. The domain name may contain several labels, separated by dots.
......
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