Documentation improvements

svn path=/trunk/; revision=7453

diff --git a/ChangeLog b/ChangeLog
index 0be95a538876ad25b5c548e4cfeb3b9a21ee62c4..e9fb7ebbe38f125c00c35f945e88d154a54939ae 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2008-09-10  Matthias Clasen  <mclasen@redhat.com>
+
+       Bug 551731 – g_date_set_time[_t] docs should mention what timezone
+
+       * glib/gdate.c (g_date_set_time, g_date_set_time_t): Documentation
+       improvements proposed by Owen Taylor.
+
 2008-09-10  Matthias Clasen  <mclasen@redhat.com>
 
        Bug 551410 – gtestutils.c: using printf without prototype

diff --git a/glib/gdate.c b/glib/gdate.c
index 2b4bebf373512b7fb52ffece1f9b500595c54f65..68b779217e2316a490c5939b6f3de4e52aff2a5f 100644 (file)
--- a/glib/gdate.c
+++ b/glib/gdate.c
@@ -861,7 +861,9 @@ g_date_set_parse (GDate       *d,
  * @date: a #GDate 
  * @timet: <type>time_t</type> value to set
  *
- * Sets the value of a date from a <type>time_t</type> value. 
+ * Sets the value of a date to the date corresponding to a time 
+ * specified as a time_t. The time to date conversion is done using 
+ * the user's current timezone.
  *
  * To set the value of a date to the current day, you could write:
  * |[
@@ -919,7 +921,8 @@ g_date_set_time_t (GDate *date,
  * @date: a #GDate.
  * @time_: #GTime value to set.
  *
- * Sets the value of a date from a #GTime value. 
+ * Sets the value of a date from a #GTime value.
+ * The time to date conversion is done using the user's current timezone.
  *
  * @Deprecated:2.10: Use g_date_set_time_t() instead.
  */