diff src/eventloop.h @ 10071:af06746954de

[gaim-migrate @ 11047] sf patch 1038040: Doxygen Fixes #3 This is from Jonathan Champ (royanee) Thanks! committer: Tailor Script <[e-mail]>

--- a/src/eventloop.h	Wed Sep 29 15:01:33 2004 +0000
+++ b/src/eventloop.h	Fri Oct 01 22:08:39 2004 +0000
@@ -79,13 +79,15 @@
 /*@{*/
 /**
  * Creates a callback timer.
- * The timer will repeat until the function returns <tt>FALSE</tt>. The
+ * The timer will repeat until the function returns @c FALSE. The
  * first call will be at the end of the first interval.
  * @param interval	The time between calls of the function, in
  *					milliseconds.
  * @param function	The function to call.
- * @param data		data to pass to <tt>function</tt>.
- **/
+ * @param data		data to pass to @a function.
+ * @return A handle to the timer which can be passed to 
+ *         gaim_timeout_remove to remove the timer.
+ */
 guint gaim_timeout_add(guint interval, GSourceFunc function, gpointer data);
 
 /**