mpdclient: update the "source" documentation

[ncmpc.git] / src / mpdclient.h

diff --git a/src/mpdclient.h b/src/mpdclient.h
index bca739b78ea025dee105c0539369875c690577d1..fb083b9c4fe2cd23d21644cfe85698250b7cca60 100644 (file)
--- a/src/mpdclient.h
+++ b/src/mpdclient.h
@@ -2,7 +2,7 @@
 #define MPDCLIENT_H
 
 #include "playlist.h"
-#include "mpdclient.h"
+#include "Compiler.h"
 
 #include <mpd/client.h>
 
@@ -21,12 +21,8 @@ struct mpdclient {
        unsigned connection_id;
 
        /**
-        * If this object is non-NULL, it tracks idle events.  It is
-        * automatically called by mpdclient_get_connection() and
-        * mpdclient_put_connection().  It is not created by the
-        * mpdclient library; the user of this library has to
-        * initialize it.  However, it is freed when the MPD
-        * connection is closed.
+        * Tracks idle events.  It is automatically called by
+        * mpdclient_get_connection() and mpdclient_put_connection().
         */
        struct mpd_glib_source *source;
 
@@ -61,11 +57,9 @@ enum {
                | MPD_IDLE_OUTPUT
                | MPD_IDLE_OPTIONS
                | MPD_IDLE_UPDATE
-#if LIBMPDCLIENT_CHECK_VERSION(2,5,0)
                | MPD_IDLE_STICKER
                | MPD_IDLE_SUBSCRIPTION
                | MPD_IDLE_MESSAGE
-#endif
 };
 
 /** functions ***************************************************************/
@@ -85,14 +79,14 @@ mpdclient_new(void);
 
 void mpdclient_free(struct mpdclient *c);
 
-G_GNUC_PURE
+gcc_pure
 static inline bool
 mpdclient_is_connected(const struct mpdclient *c)
 {
        return c->connection != NULL;
 }
 
-G_GNUC_PURE
+gcc_pure
 static inline bool
 mpdclient_is_playing(const struct mpdclient *c)
 {
@@ -101,7 +95,7 @@ mpdclient_is_playing(const struct mpdclient *c)
                 mpd_status_get_state(c->status) == MPD_STATE_PAUSE);
 }
 
-G_GNUC_PURE
+gcc_pure
 static inline const struct mpd_song *
 mpdclient_get_current_song(const struct mpdclient *c)
 {
@@ -126,13 +120,6 @@ mpdclient_get_connection(struct mpdclient *c);
 void
 mpdclient_put_connection(struct mpdclient *c);
 
-/**
- * To be implemented by the application: mpdclient.c calls this to
- * display an error message.
- */
-void
-mpdclient_ui_error(const char *message);
-
 /*** MPD Commands  **********************************************************/
 
 bool
@@ -165,7 +152,6 @@ mpdclient_cmd_delete_range(struct mpdclient *c, unsigned start, unsigned end);
 bool
 mpdclient_cmd_move(struct mpdclient *c, unsigned dest, unsigned src);
 
-#if LIBMPDCLIENT_CHECK_VERSION(2,5,0)
 bool
 mpdclient_cmd_subscribe(struct mpdclient *c, const char *channel);
 
@@ -181,7 +167,6 @@ mpdclient_send_read_messages(struct mpdclient *c);
 
 struct mpd_message *
 mpdclient_recv_message(struct mpdclient *c);
-#endif
 
 /*** playlist functions  **************************************************/
 
@@ -197,7 +182,4 @@ mpdclient_playlist_update_changes(struct mpdclient *c);
 bool
 mpdclient_filelist_add_all(struct mpdclient *c, struct filelist *fl);
 
-/* sort by list-format */
-gint compare_filelistentry_format(gconstpointer filelist_entry1, gconstpointer filelist_entry2);
-
 #endif