Remove config_GetCacheDir

[vlc] / src / playlist / fetcher.h

diff --git a/src/playlist/fetcher.h b/src/playlist/fetcher.h
index 1c422ccad1423d46f466f73be8b9524ba6abdbee..5a7616ee1e08a76ba726c226fe6a4c00133165b5 100644 (file)
--- a/src/playlist/fetcher.h
+++ b/src/playlist/fetcher.h
@@ -25,22 +25,32 @@
 #ifndef _PLAYLIST_FETCHER_H
 #define _PLAYLIST_FETCHER_H 1
 
-typedef struct
-{
-    playlist_t      *p_playlist;
-
-    vlc_thread_t    thread;
-    vlc_mutex_t     lock;
-    vlc_cond_t      wait;
-    int             i_art_policy;
-    int             i_waiting;
-    input_item_t    **pp_waiting;
-
-    DECL_ARRAY(playlist_album_t) albums;
-} playlist_fetcher_t;
+/**
+ * Fetcher opaque structure.
+ *
+ * The fether object will retreive the art album data for any given input
+ * item in an asynchronous way.
+ */
+typedef struct playlist_fetcher_t playlist_fetcher_t;
 
+/**
+ * This function creates the fetcher object and thread.
+ */
 playlist_fetcher_t *playlist_fetcher_New( playlist_t * );
+
+/**
+ * This function enqueues the provided item to be art fetched.
+ *
+ * The input item is retained until the art fetching is done or until the
+ * fetcher object is destroyed.
+ */
 void playlist_fetcher_Push( playlist_fetcher_t *, input_item_t * );
+
+/**
+ * This function destroys the fetcher object and thread.
+ *
+ * All pending input items will be released.
+ */
 void playlist_fetcher_Delete( playlist_fetcher_t * );
 
 #endif