Improve doc for g_date_strftime(). (#346197)

2006-07-20  Tor Lillqvist  <tml@novell.com>

	* glib/tmpl/date.sgml: Improve doc for
	g_date_strftime(). (#346197)

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index bf55e47..095959a 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+2006-07-20  Tor Lillqvist  <tml@novell.com>
+
+       * glib/tmpl/date.sgml: Improve doc for
+       g_date_strftime(). (#346197)
+
 2006-07-05  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/tmpl/base64.sgml: Remove bogus reference

diff --git a/docs/reference/glib/tmpl/date.sgml b/docs/reference/glib/tmpl/date.sgml
index 4abf160..4ae06be 100644 (file)
--- a/docs/reference/glib/tmpl/date.sgml
+++ b/docs/reference/glib/tmpl/date.sgml
@@ -685,9 +685,20 @@ to be a Sunday.)
 <!-- ##### FUNCTION g_date_strftime ##### -->
 <para>
 Generates a printed representation of the date, in a locale-specific
-way. Works just like the standard C <function>strftime()</function>
-function, but only accepts date-related formats; time-related formats
-give undefined results. Date must be valid.
+way. Works just like the platform's C library
+<function>strftime()</function> function, but only accepts
+date-related formats; time-related formats give undefined
+results. Date must be valid. Unlike <function>strftime()</function>
+(which uses the locale encoding), works on a UTF-8 format string and
+stores a UTF-8 result.
+</para>
+
+<para>
+This function does not provide any conversion specifiers in addition
+to those implemented by the platform's C library. For example, don't
+expect that using <function>g_date_strftime()</function> would make
+the %F provided by the C99 <function>strftime()</function> work on
+Windows where the C library only complies to C89.
 </para>
 
 @s: destination buffer.