list_window: convert comments to doxygen

[ncmpc.git] / src / gidle.h

diff --git a/src/gidle.h b/src/gidle.h
index 3b460e214d54b74651f3abac36ff80b2647ab135..1a59437b0a2d40e88d19674362aa1a718968af9a 100644 (file)
--- a/src/gidle.h
+++ b/src/gidle.h
@@ -1,5 +1,5 @@
 /* ncmpc (Ncurses MPD Client)
-   (c) 2004-2009 The Music Player Daemon Project
+   (c) 2004-2017 The Music Player Daemon Project
    Project homepage: http://musicpd.org
 
    Redistribution and use in source and binary forms, with or without
@@ -45,10 +45,22 @@ mpd_glib_new(struct mpd_connection *connection,
 void
 mpd_glib_free(struct mpd_glib_source *source);
 
-void
+/**
+ * Enters idle mode.
+ *
+ * @return true if idle mode has been entered, false if not
+ * (e.g. blocked during the callback, or I/O error)
+ */
+bool
 mpd_glib_enter(struct mpd_glib_source *source);
 
-void
+/**
+ * Leaves idle mode and invokes the callback if there were events.
+ *
+ * @return true on success, false if this object was deleted by the
+ * callback
+ */
+bool
 mpd_glib_leave(struct mpd_glib_source *source);
 
 #endif