Improve docs for return value and @microseconds out parameter. (Reported

Tue Dec 10 11:55:28 2002  Owen Taylor  <otaylor@redhat.com>

        * glib/tmpl/timers.sgml: Improve docs for return value
        and @microseconds out parameter. (Reported by
        Dennis Haney, #100841)

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index f8c02f6..2243ab7 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,9 @@
+Tue Dec 10 11:55:28 2002  Owen Taylor  <otaylor@redhat.com>
+
+       * glib/tmpl/timers.sgml: Improve docs for return value
+       and @microseconds out parameter. (Reported by
+       Dennis Haney, #100841)
+
 2002-12-10  Matthias Clasen  <maclas@gmx.de>
 
        * gobject/tmpl/generic_values.sgml: 

diff --git a/docs/reference/glib/tmpl/timers.sgml b/docs/reference/glib/tmpl/timers.sgml
index 2cdb8f7..bc2d4a6 100644 (file)
--- a/docs/reference/glib/tmpl/timers.sgml
+++ b/docs/reference/glib/tmpl/timers.sgml
@@ -57,14 +57,16 @@ between this end time and the start time.
 If @timer has been started but not stopped, obtains the time since the timer was
 started. If @timer has been stopped, obtains the elapsed time between the time
 it was started and the time it was stopped. The return value is the number of
-seconds elapsed, and the @microseconds argument allows you to get the number of
-microseconds.
+seconds elapsed, including any fractional part. The @microseconds
+out parameter is essentially useless.
 </para>
 
 @timer: a #GTimer.
-@microseconds: return location for microseconds elapsed, or %NULL.
-@Returns: seconds elapsed.
-
+@microseconds: fractional part of seconds elapsed, in microseconds
+  (that is, the total number of microseconds elapsed, modulo 
+   1000000)
+@Returns: seconds elapsed as a floating point value, including 
+  any fractional part.
 
 <!-- ##### FUNCTION g_timer_reset ##### -->
 <para>