Mercurial > pidgin
comparison src/eventloop.h @ 10071:af06746954de
[gaim-migrate @ 11047]
sf patch 1038040: Doxygen Fixes #3
This is from Jonathan Champ (royanee)
Thanks!
committer: Tailor Script <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Fri, 01 Oct 2004 22:08:39 +0000 |
parents | 34bce9529cf4 |
children | fcb3f77df50d |
comparison
equal
deleted
inserted
replaced
10070:2b6bf836c6b9 | 10071:af06746954de |
---|---|
77 /** @name Event Loop API */ | 77 /** @name Event Loop API */ |
78 /**************************************************************************/ | 78 /**************************************************************************/ |
79 /*@{*/ | 79 /*@{*/ |
80 /** | 80 /** |
81 * Creates a callback timer. | 81 * Creates a callback timer. |
82 * The timer will repeat until the function returns <tt>FALSE</tt>. The | 82 * The timer will repeat until the function returns @c FALSE. The |
83 * first call will be at the end of the first interval. | 83 * first call will be at the end of the first interval. |
84 * @param interval The time between calls of the function, in | 84 * @param interval The time between calls of the function, in |
85 * milliseconds. | 85 * milliseconds. |
86 * @param function The function to call. | 86 * @param function The function to call. |
87 * @param data data to pass to <tt>function</tt>. | 87 * @param data data to pass to @a function. |
88 **/ | 88 * @return A handle to the timer which can be passed to |
89 * gaim_timeout_remove to remove the timer. | |
90 */ | |
89 guint gaim_timeout_add(guint interval, GSourceFunc function, gpointer data); | 91 guint gaim_timeout_add(guint interval, GSourceFunc function, gpointer data); |
90 | 92 |
91 /** | 93 /** |
92 * Removes a timeout handler. | 94 * Removes a timeout handler. |
93 * | 95 * |