changeset 8587:699cc19a40d6

[gaim-migrate @ 9338] Documentation update. It's a minor one, but fits the rest of the documentation a little better, and fixes a Doxygen warning. committer: Tailor Script <tailor@pidgin.im>
author Christian Hammond <chipx86@chipx86.com>
date Mon, 05 Apr 2004 22:51:43 +0000
parents 5af95c2b1179
children 7f7679853f7b
files src/gtkeventloop.h
diffstat 1 files changed, 8 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/src/gtkeventloop.h	Mon Apr 05 20:42:13 2004 +0000
+++ b/src/gtkeventloop.h	Mon Apr 05 22:51:43 2004 +0000
@@ -1,5 +1,5 @@
 /**
- * @file gtkeventloop.h Gaim Event Loop API (gtk implementation)
+ * @file gtkeventloop.h Gaim GTK+ Event Loop Implementation
  * @ingroup gtkui
  *
  * gaim
@@ -22,13 +22,16 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
-#ifndef _GAIM_GTKEVENTLOOP_H_
-#define _GAIM_GTKEVENTLOOP_H_
+#ifndef _GAIM_GTK_EVENT_LOOP_H_
+#define _GAIM_GTK_EVENT_LOOP_H_
+
 #include "eventloop.h"
 
 /**
- * Gets a static pointer to a gtk implementation of an eventloop.
+ * Returns the GTK+ event loop UI operations structure.
+ *
+ * @return The GTK+ event loop UI operations structure.
  */
 GaimEventLoopUiOps *gaim_gtk_eventloop_get_ui_ops(void);
 
-#endif /* _GAIM_GTKEVENTLOOP_H_ */
+#endif /* _GAIM_GTK_EVENT_LOOP_H_ */