[tepl] docs: improve doc of tepl_encoding_get_default_candidates()
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [tepl] docs: improve doc of tepl_encoding_get_default_candidates()
- Date: Sun, 22 Oct 2017 13:39:59 +0000 (UTC)
commit 08b61ff773810574835f381f654eb0c90704ca55
Author: Sébastien Wilmet <swilmet gnome org>
Date: Sun Oct 22 15:38:23 2017 +0200
docs: improve doc of tepl_encoding_get_default_candidates()
tepl/tepl-encoding.c | 4 ++++
1 files changed, 4 insertions(+), 0 deletions(-)
---
diff --git a/tepl/tepl-encoding.c b/tepl/tepl-encoding.c
index dbe554e..4c2d545 100644
--- a/tepl/tepl-encoding.c
+++ b/tepl/tepl-encoding.c
@@ -628,6 +628,10 @@ strv_to_list (const gchar * const *enc_str)
* language, country and default encoding). The UTF-8 encoding and the current
* locale encoding are guaranteed to be present in the returned list.
*
+ * Note that the returned list doesn't contain all encodings known by
+ * #TeplEncoding, it is a limited list that contains only the encodings that
+ * have the most likelihood to fit for the current locale.
+ *
* Returns: (transfer full) (element-type TeplEncoding): the list of default
* candidate encodings.
* Since: 2.0
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]