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)
This commit is contained in:
Owen Taylor 2002-12-10 16:57:25 +00:00 committed by Owen Taylor
parent df9d9332f8
commit 63524f96ee
2 changed files with 13 additions and 5 deletions

View File

@ -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:

View File

@ -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>