Re: glib: GTimer patch for elapsed time
- From: "Matthias Clasen" <Matthias Clasen poet de>
- To: Sven Neumann <sven gimp org>
- Cc: Gavin Baker <gavinb antonym org>, gtk-devel-list gnome org, gtk-devel-list-admin gnome org
- Subject: Re: glib: GTimer patch for elapsed time
- Date: Mon, 15 Jul 2002 16:45:09 +0200
> I was under the impression that the return value should be documented
> after the function is described, in other words like this:
>
> /**
> * g_timer_new:
> *
> * Creates a new GTimer, and starts timing (ie. a #g_timer_start()
> * is implicitly called for you).
> *
> * Return value: a new #GTimer
> **/
>
> at least that's what emacs inserts for me when I type
> 'M-x gnome-doc-insert' and I think it also looks cleaner.
Both forms work. @returns has the advantage that it stops gtk-doc from
taking any line that happens to start with "returns" as return value
documentation. (Wasn't it you who filed
http://bugzilla.gnome.org/show_bug.cgi?id=69660, Sven ?)
The # in front of g_timer_start() is a markup error, btw.
Matthias
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]