From: Tor Lillqvist <tml@iki.fi>
Date: Mon, 20 Dec 2004 22:33:11 +0000 (+0000)
Subject: Improve docs.
X-Git-Tag: GLIB_2_6_1~24
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=8693257c0638e1428e0fbbfdd1f2b8137dcaabc1;p=platform%2Fupstream%2Fglib.git

Improve docs.

2004-12-20  Tor Lillqvist  <tml@iki.fi>

	* glib/gconvert.c (g_locale_to_utf8, g_filename_to_uri): Improve
	docs.
---

diff --git a/ChangeLog b/ChangeLog
index 3260aeb..960acfa 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2004-12-20  Tor Lillqvist  <tml@iki.fi>
+
+	* glib/gconvert.c (g_locale_to_utf8, g_filename_to_uri): Improve
+	docs.
+
 2004-12-20  Matthias Clasen  <mclasen@redhat.com>
 
 	* tests/option-test.c: Add some tests for '--' 
diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index 3260aeb..960acfa 100644
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,3 +1,8 @@
+2004-12-20  Tor Lillqvist  <tml@iki.fi>
+
+	* glib/gconvert.c (g_locale_to_utf8, g_filename_to_uri): Improve
+	docs.
+
 2004-12-20  Matthias Clasen  <mclasen@redhat.com>
 
 	* tests/option-test.c: Add some tests for '--' 
diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12
index 3260aeb..960acfa 100644
--- a/ChangeLog.pre-2-12
+++ b/ChangeLog.pre-2-12
@@ -1,3 +1,8 @@
+2004-12-20  Tor Lillqvist  <tml@iki.fi>
+
+	* glib/gconvert.c (g_locale_to_utf8, g_filename_to_uri): Improve
+	docs.
+
 2004-12-20  Matthias Clasen  <mclasen@redhat.com>
 
 	* tests/option-test.c: Add some tests for '--' 
diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6
index 3260aeb..960acfa 100644
--- a/ChangeLog.pre-2-6
+++ b/ChangeLog.pre-2-6
@@ -1,3 +1,8 @@
+2004-12-20  Tor Lillqvist  <tml@iki.fi>
+
+	* glib/gconvert.c (g_locale_to_utf8, g_filename_to_uri): Improve
+	docs.
+
 2004-12-20  Matthias Clasen  <mclasen@redhat.com>
 
 	* tests/option-test.c: Add some tests for '--' 
diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index 3260aeb..960acfa 100644
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,3 +1,8 @@
+2004-12-20  Tor Lillqvist  <tml@iki.fi>
+
+	* glib/gconvert.c (g_locale_to_utf8, g_filename_to_uri): Improve
+	docs.
+
 2004-12-20  Matthias Clasen  <mclasen@redhat.com>
 
 	* tests/option-test.c: Add some tests for '--' 
diff --git a/glib/gconvert.c b/glib/gconvert.c
index 1458759..2ebcfdf 100644
--- a/glib/gconvert.c
+++ b/glib/gconvert.c
@@ -913,7 +913,8 @@ strdup_len (const gchar *string,
 
 /**
  * g_locale_to_utf8:
- * @opsysstring:   a string in the encoding of the current locale
+ * @opsysstring:   a string in the encoding of the current locale. On Windows
+ *                 this means the system codepage.
  * @len:           the length of the string, or -1 if the string is
  *                 nul-terminated.
  * @bytes_read:    location to store the number of bytes in the
@@ -1722,8 +1723,9 @@ g_filename_from_uri (const gchar *uri,
 
 /**
  * g_filename_to_uri:
- * @filename: an absolute filename specified in the encoding
- *            used for filenames by the operating system.
+ * @filename: an absolute filename specified in the GLib file name encoding,
+ *            which is the on-disk file name bytes on Unix, and UTF-8 on 
+ *            Windows
  * @hostname: A UTF-8 encoded hostname, or %NULL for none.
  * @error: location to store the error occuring, or %NULL to ignore
  *         errors. Any of the errors in #GConvertError may occur.