Mercurial > audlegacy

changeset 2053:4ecd967bfd8f trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[svn] - add gtkdoc settings - document util.c
author nenolod
date Mon, 04 Dec 2006 13:25:25 -0800
parents 5e7744e13f19
children a98e05ffcf07
files ChangeLog doc/libaudacious/libaudacious-decl-list.txt doc/libaudacious/libaudacious-decl.txt doc/libaudacious/libaudacious-overrides.txt doc/libaudacious/libaudacious-sections.txt doc/libaudacious/libaudacious-undocumented.txt doc/libaudacious/libaudacious-unused.txt doc/libaudacious/tmpl/util.sgml libaudacious/util.c
diffstat 7 files changed, 1210 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog	Mon Dec 04 02:18:02 2006 -0800
+++ b/ChangeLog	Mon Dec 04 13:25:25 2006 -0800
@@ -1,3 +1,11 @@
+2006-12-04 10:18:02 +0000  William Pitcock <nenolod@nenolod.net>
+  revision [3107]
+  - what the hell is this, and why do we need it?
+  
+  trunk/libaudacious/configdb_xmlfile.c |  203 ----------------------------------
+  1 file changed, 203 deletions(-)
+
+
 2006-12-04 10:07:12 +0000  William Pitcock <nenolod@nenolod.net>
   revision [3105]
   - add some missing docs
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libaudacious/libaudacious-decl-list.txt	Mon Dec 04 13:25:25 2006 -0800
@@ -0,0 +1,175 @@
+<SECTION>
+<FILE>vfs</FILE>
+VFSFile
+VFSConstructor
+vfs_init
+vfs_fopen
+vfs_fclose
+vfs_fread
+vfs_fwrite
+vfs_getc
+vfs_ungetc
+vfs_fgets
+vfs_fseek
+vfs_rewind
+vfs_ftell
+vfs_feof
+vfs_file_test
+vfs_is_writeable
+vfs_truncate
+vfs_fprintf
+vfs_register_transport
+</SECTION>
+
+<SECTION>
+<FILE>beepctrl</FILE>
+xmms_connect_to_session
+xmms_remote_playlist
+xmms_remote_get_version
+xmms_remote_playlist_add
+xmms_remote_playlist_delete
+xmms_remote_play
+xmms_remote_pause
+xmms_remote_stop
+xmms_remote_is_playing
+xmms_remote_is_paused
+xmms_remote_get_playlist_pos
+xmms_remote_set_playlist_pos
+xmms_remote_get_playlist_length
+xmms_remote_playlist_clear
+xmms_remote_get_output_time
+xmms_remote_jump_to_time
+xmms_remote_get_volume
+xmms_remote_get_main_volume
+xmms_remote_get_balance
+xmms_remote_set_volume
+xmms_remote_set_main_volume
+xmms_remote_set_balance
+xmms_remote_get_skin
+xmms_remote_set_skin
+xmms_remote_get_playlist_file
+xmms_remote_get_playlist_title
+xmms_remote_get_playlist_time
+xmms_remote_get_info
+xmms_remote_main_win_toggle
+xmms_remote_pl_win_toggle
+xmms_remote_eq_win_toggle
+xmms_remote_is_main_win
+xmms_remote_is_pl_win
+xmms_remote_is_eq_win
+xmms_remote_show_prefs_box
+xmms_remote_toggle_aot
+xmms_remote_eject
+xmms_remote_playlist_prev
+xmms_remote_playlist_next
+xmms_remote_playlist_add_url_string
+xmms_remote_is_running
+xmms_remote_toggle_repeat
+xmms_remote_toggle_shuffle
+xmms_remote_is_repeat
+xmms_remote_is_shuffle
+xmms_remote_get_eq
+xmms_remote_get_eq_preamp
+xmms_remote_get_eq_band
+xmms_remote_set_eq
+xmms_remote_set_eq_preamp
+xmms_remote_set_eq_band
+xmms_remote_quit
+xmms_remote_play_pause
+xmms_remote_playlist_ins_url_string
+xmms_remote_playqueue_add
+xmms_remote_playqueue_remove
+xmms_remote_get_playqueue_length
+xmms_remote_toggle_advance
+xmms_remote_is_advance
+xmms_remote_activate
+xmms_remote_show_jtf_box
+xmms_remote_playqueue_clear
+xmms_remote_playqueue_is_queued
+xmms_remote_get_playqueue_position
+xmms_remote_get_playqueue_queue_position
+audacious_set_session_uri
+audacious_get_session_uri
+audacious_set_session_type
+xmms_remote_play_files
+xmms_remote_add_files
+</SECTION>
+
+<SECTION>
+<FILE>titlestring</FILE>
+TitleInput
+BmpTitleInput
+XMMS_TITLEINPUT_SIZE
+XMMS_TITLEINPUT_VERSION
+XMMS_NEW_TITLEINPUT
+bmp_title_input_new
+bmp_title_input_free
+xmms_get_titlestring
+xmms_titlestring_descriptions
+</SECTION>
+
+<SECTION>
+<FILE>formatter</FILE>
+Formatter
+xmms_formatter_new
+xmms_formatter_destroy
+xmms_formatter_associate
+xmms_formatter_dissociate
+xmms_formatter_format
+</SECTION>
+
+<SECTION>
+<FILE>rcfile</FILE>
+RcLine
+RcSection
+RcFile
+bmp_rcfile_new
+bmp_rcfile_free
+bmp_rcfile_open
+bmp_rcfile_write
+bmp_rcfile_read_string
+bmp_rcfile_read_int
+bmp_rcfile_read_bool
+bmp_rcfile_read_float
+bmp_rcfile_read_double
+bmp_rcfile_write_string
+bmp_rcfile_write_int
+bmp_rcfile_write_boolean
+bmp_rcfile_write_float
+bmp_rcfile_write_double
+bmp_rcfile_remove_key
+</SECTION>
+
+<SECTION>
+<FILE>xconvert</FILE>
+convert_free_buffer
+xmms_convert_buffers
+</SECTION>
+
+<SECTION>
+<FILE>configdb</FILE>
+ConfigDb
+bmp_cfg_db_open
+bmp_cfg_db_close
+bmp_cfg_db_get_string
+bmp_cfg_db_get_int
+bmp_cfg_db_get_bool
+bmp_cfg_db_get_float
+bmp_cfg_db_get_double
+bmp_cfg_db_set_string
+bmp_cfg_db_set_int
+bmp_cfg_db_set_bool
+bmp_cfg_db_set_float
+bmp_cfg_db_set_double
+bmp_cfg_db_unset_key
+</SECTION>
+
+<SECTION>
+<FILE>util</FILE>
+</SECTION>
+
+<SECTION>
+<FILE>dirbrowser</FILE>
+xmms_create_dir_browser
+</SECTION>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libaudacious/libaudacious-decl.txt	Mon Dec 04 13:25:25 2006 -0800
@@ -0,0 +1,739 @@
+<STRUCT>
+<NAME>VFSFile</NAME>
+</STRUCT>
+<STRUCT>
+<NAME>VFSConstructor</NAME>
+</STRUCT>
+<STRUCT>
+<NAME>VFSFile</NAME>
+struct _VFSFile {
+	gchar *uri;
+	gpointer handle;
+	VFSConstructor *base;
+};
+</STRUCT>
+<STRUCT>
+<NAME>VFSConstructor</NAME>
+struct _VFSConstructor {
+	gchar *uri_id;
+	VFSFile *(*vfs_fopen_impl)(const gchar *path,
+		const gchar *mode);
+	gint (*vfs_fclose_impl)(VFSFile * file);
+	size_t (*vfs_fread_impl)(gpointer ptr, size_t size,
+		size_t nmemb, VFSFile *file);
+	size_t (*vfs_fwrite_impl)(gconstpointer ptr, size_t size,
+		size_t nmemb, VFSFile *file);
+	gint (*vfs_getc_impl)(VFSFile *stream);
+	gint (*vfs_ungetc_impl)(gint c, VFSFile *stream);
+	gint (*vfs_fseek_impl)(VFSFile *file, glong offset, gint whence);
+	void (*vfs_rewind_impl)(VFSFile *file);
+	glong (*vfs_ftell_impl)(VFSFile *file);
+	gboolean (*vfs_feof_impl)(VFSFile *file);
+	gboolean (*vfs_truncate_impl)(VFSFile *file, glong length);
+};
+</STRUCT>
+<FUNCTION>
+<NAME>vfs_init</NAME>
+<RETURNS>gboolean </RETURNS>
+void
+</FUNCTION>
+<FUNCTION>
+<NAME>vfs_fopen</NAME>
+<RETURNS>VFSFile *</RETURNS>
+const gchar * path,const gchar * mode
+</FUNCTION>
+<FUNCTION>
+<NAME>vfs_fclose</NAME>
+<RETURNS>gint </RETURNS>
+VFSFile * file
+</FUNCTION>
+<FUNCTION>
+<NAME>vfs_fread</NAME>
+<RETURNS>size_t </RETURNS>
+gpointer ptr,size_t size,size_t nmemb,VFSFile * file
+</FUNCTION>
+<FUNCTION>
+<NAME>vfs_fwrite</NAME>
+<RETURNS>size_t </RETURNS>
+gconstpointer ptr,size_t size,size_t nmemb,VFSFile *file
+</FUNCTION>
+<FUNCTION>
+<NAME>vfs_getc</NAME>
+<RETURNS>gint </RETURNS>
+VFSFile *stream
+</FUNCTION>
+<FUNCTION>
+<NAME>vfs_ungetc</NAME>
+<RETURNS>gint </RETURNS>
+gint c,VFSFile *stream
+</FUNCTION>
+<FUNCTION>
+<NAME>vfs_fgets</NAME>
+<RETURNS>gchar *</RETURNS>
+gchar *s,gint n,VFSFile *stream
+</FUNCTION>
+<FUNCTION>
+<NAME>vfs_fseek</NAME>
+<RETURNS>gint </RETURNS>
+VFSFile * file,glong offset,gint whence
+</FUNCTION>
+<FUNCTION>
+<NAME>vfs_rewind</NAME>
+<RETURNS>void </RETURNS>
+VFSFile * file
+</FUNCTION>
+<FUNCTION>
+<NAME>vfs_ftell</NAME>
+<RETURNS>glong </RETURNS>
+VFSFile * file
+</FUNCTION>
+<FUNCTION>
+<NAME>vfs_feof</NAME>
+<RETURNS>gboolean </RETURNS>
+VFSFile * file
+</FUNCTION>
+<FUNCTION>
+<NAME>vfs_file_test</NAME>
+<RETURNS>gboolean </RETURNS>
+const gchar * path,GFileTest test
+</FUNCTION>
+<FUNCTION>
+<NAME>vfs_is_writeable</NAME>
+<RETURNS>gboolean </RETURNS>
+const gchar * path
+</FUNCTION>
+<FUNCTION>
+<NAME>vfs_truncate</NAME>
+<RETURNS>gboolean </RETURNS>
+VFSFile * file, glong length
+</FUNCTION>
+<FUNCTION>
+<NAME>vfs_fprintf</NAME>
+<RETURNS>int </RETURNS>
+VFSFile *stream, gchar const *format, ...
+</FUNCTION>
+<FUNCTION>
+<NAME>vfs_register_transport</NAME>
+<RETURNS>gboolean </RETURNS>
+VFSConstructor *vtable
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_connect_to_session</NAME>
+<RETURNS>gint </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_playlist</NAME>
+<RETURNS>void </RETURNS>
+gint session, gchar ** list, gint num,gboolean enqueue
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_version</NAME>
+<RETURNS>gint </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_playlist_add</NAME>
+<RETURNS>void </RETURNS>
+gint session, GList * list
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_playlist_delete</NAME>
+<RETURNS>void </RETURNS>
+gint session, gint pos
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_play</NAME>
+<RETURNS>void </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_pause</NAME>
+<RETURNS>void </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_stop</NAME>
+<RETURNS>void </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_is_playing</NAME>
+<RETURNS>gboolean </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_is_paused</NAME>
+<RETURNS>gboolean </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_playlist_pos</NAME>
+<RETURNS>gint </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_set_playlist_pos</NAME>
+<RETURNS>void </RETURNS>
+gint session, gint pos
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_playlist_length</NAME>
+<RETURNS>gint </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_playlist_clear</NAME>
+<RETURNS>void </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_output_time</NAME>
+<RETURNS>gint </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_jump_to_time</NAME>
+<RETURNS>void </RETURNS>
+gint session, gint pos
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_volume</NAME>
+<RETURNS>void </RETURNS>
+gint session, gint * vl, gint * vr
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_main_volume</NAME>
+<RETURNS>gint </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_balance</NAME>
+<RETURNS>gint </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_set_volume</NAME>
+<RETURNS>void </RETURNS>
+gint session, gint vl, gint vr
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_set_main_volume</NAME>
+<RETURNS>void </RETURNS>
+gint session, gint v
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_set_balance</NAME>
+<RETURNS>void </RETURNS>
+gint session, gint b
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_skin</NAME>
+<RETURNS>gchar *</RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_set_skin</NAME>
+<RETURNS>void </RETURNS>
+gint session, gchar * skinfile
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_playlist_file</NAME>
+<RETURNS>gchar *</RETURNS>
+gint session, gint pos
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_playlist_title</NAME>
+<RETURNS>gchar *</RETURNS>
+gint session, gint pos
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_playlist_time</NAME>
+<RETURNS>gint </RETURNS>
+gint session, gint pos
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_info</NAME>
+<RETURNS>void </RETURNS>
+gint session, gint * rate, gint * freq,gint * nch
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_main_win_toggle</NAME>
+<RETURNS>void </RETURNS>
+gint session, gboolean show
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_pl_win_toggle</NAME>
+<RETURNS>void </RETURNS>
+gint session, gboolean show
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_eq_win_toggle</NAME>
+<RETURNS>void </RETURNS>
+gint session, gboolean show
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_is_main_win</NAME>
+<RETURNS>gboolean </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_is_pl_win</NAME>
+<RETURNS>gboolean </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_is_eq_win</NAME>
+<RETURNS>gboolean </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_show_prefs_box</NAME>
+<RETURNS>void </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_toggle_aot</NAME>
+<RETURNS>void </RETURNS>
+gint session, gboolean ontop
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_eject</NAME>
+<RETURNS>void </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_playlist_prev</NAME>
+<RETURNS>void </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_playlist_next</NAME>
+<RETURNS>void </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_playlist_add_url_string</NAME>
+<RETURNS>void </RETURNS>
+gint session, gchar * string
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_is_running</NAME>
+<RETURNS>gboolean </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_toggle_repeat</NAME>
+<RETURNS>void </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_toggle_shuffle</NAME>
+<RETURNS>void </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_is_repeat</NAME>
+<RETURNS>gboolean </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_is_shuffle</NAME>
+<RETURNS>gboolean </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_eq</NAME>
+<RETURNS>void </RETURNS>
+gint session, gfloat * preamp,gfloat ** bands
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_eq_preamp</NAME>
+<RETURNS>gfloat </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_eq_band</NAME>
+<RETURNS>gfloat </RETURNS>
+gint session, gint band
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_set_eq</NAME>
+<RETURNS>void </RETURNS>
+gint session, gfloat preamp, gfloat * bands
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_set_eq_preamp</NAME>
+<RETURNS>void </RETURNS>
+gint session, gfloat preamp
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_set_eq_band</NAME>
+<RETURNS>void </RETURNS>
+gint session, gint band, gfloat value
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_quit</NAME>
+<RETURNS>void </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_play_pause</NAME>
+<RETURNS>void </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_playlist_ins_url_string</NAME>
+<RETURNS>void </RETURNS>
+gint session, gchar * string,gint pos
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_playqueue_add</NAME>
+<RETURNS>void </RETURNS>
+gint session, gint pos
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_playqueue_remove</NAME>
+<RETURNS>void </RETURNS>
+gint session, gint pos
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_playqueue_length</NAME>
+<RETURNS>gint </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_toggle_advance</NAME>
+<RETURNS>void </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_is_advance</NAME>
+<RETURNS>gboolean </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_activate</NAME>
+<RETURNS>void </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_show_jtf_box</NAME>
+<RETURNS>void </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_playqueue_clear</NAME>
+<RETURNS>void </RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_playqueue_is_queued</NAME>
+<RETURNS>gboolean </RETURNS>
+gint session, gint pos
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_playqueue_position</NAME>
+<RETURNS>gint </RETURNS>
+gint session, gint pos
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_get_playqueue_queue_position</NAME>
+<RETURNS>gint </RETURNS>
+gint session, gint pos
+</FUNCTION>
+<FUNCTION>
+<NAME>audacious_set_session_uri</NAME>
+<RETURNS>void </RETURNS>
+gchar *uri
+</FUNCTION>
+<FUNCTION>
+<NAME>audacious_get_session_uri</NAME>
+<RETURNS>gchar *</RETURNS>
+gint session
+</FUNCTION>
+<FUNCTION>
+<NAME>audacious_set_session_type</NAME>
+<RETURNS>void </RETURNS>
+gint type
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_remote_play_files</NAME>
+<RETURNS>void </RETURNS>
+gint session, GList * list
+</FUNCTION>
+<MACRO>
+<NAME>xmms_remote_add_files</NAME>
+#define xmms_remote_add_files(session,list) \
+        xmms_remote_playlist_add(session,list)
+</MACRO>
+<STRUCT>
+<NAME>TitleInput</NAME>
+typedef struct {
+    gint __size;                /* Set by bmp_title_input_new() */
+    gint __version;             /* Ditto */
+
+    gchar *performer;           /* %p */
+    gchar *album_name;          /* %a */
+    gchar *track_name;          /* %t */
+    gint track_number;          /* %n */
+    gint year;                  /* %y */
+    gchar *date;                /* %d */
+    gchar *genre;               /* %g */
+    gchar *comment;             /* %c */
+    gchar *file_name;           /* %f */
+    const gchar *file_ext;      /* %e *//* is not always strdup'ed, see xmms_input_get_song_info and plugins! */
+    gchar *file_path;           /* %F */
+    gint length;		/* not displayable */
+    gchar *formatter;		/* not displayable */
+    time_t mtime;
+} TitleInput;
+</STRUCT>
+<TYPEDEF>
+<NAME>BmpTitleInput</NAME>
+typedef TitleInput BmpTitleInput;
+</TYPEDEF>
+<MACRO>
+<NAME>XMMS_TITLEINPUT_SIZE</NAME>
+#define XMMS_TITLEINPUT_SIZE	sizeof(TitleInput)
+</MACRO>
+<MACRO>
+<NAME>XMMS_TITLEINPUT_VERSION</NAME>
+#define XMMS_TITLEINPUT_VERSION	(1)
+</MACRO>
+<MACRO>
+<NAME>XMMS_NEW_TITLEINPUT</NAME>
+#define XMMS_NEW_TITLEINPUT(input) G_STMT_START { \
+    input = g_new0(TitleInput, 1);                \
+    input->__size = XMMS_TITLEINPUT_SIZE;         \
+    input->__version = XMMS_TITLEINPUT_VERSION;   \
+} G_STMT_END
+</MACRO>
+<FUNCTION>
+<NAME>bmp_title_input_new</NAME>
+<RETURNS>TitleInput *</RETURNS>
+void
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_title_input_free</NAME>
+<RETURNS>void </RETURNS>
+BmpTitleInput * input
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_get_titlestring</NAME>
+<RETURNS>gchar *</RETURNS>
+const gchar * fmt, TitleInput * input
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_titlestring_descriptions</NAME>
+<RETURNS>GtkWidget *</RETURNS>
+gchar * tags, gint rows
+</FUNCTION>
+<STRUCT>
+<NAME>Formatter</NAME>
+typedef struct {
+    gchar *values[256];
+} Formatter;
+</STRUCT>
+<FUNCTION>
+<NAME>xmms_formatter_new</NAME>
+<RETURNS>Formatter *</RETURNS>
+void
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_formatter_destroy</NAME>
+<RETURNS>void </RETURNS>
+Formatter * formatter
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_formatter_associate</NAME>
+<RETURNS>void </RETURNS>
+Formatter * formatter, guchar id,gchar * value
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_formatter_dissociate</NAME>
+<RETURNS>void </RETURNS>
+Formatter * formatter, guchar id
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_formatter_format</NAME>
+<RETURNS>gchar *</RETURNS>
+Formatter * formatter, gchar * format
+</FUNCTION>
+<STRUCT>
+<NAME>RcLine</NAME>
+typedef struct {
+    gchar *key;
+    gchar *value;
+} RcLine;
+</STRUCT>
+<STRUCT>
+<NAME>RcSection</NAME>
+typedef struct {
+    gchar *name;
+    GList *lines;
+} RcSection;
+</STRUCT>
+<STRUCT>
+<NAME>RcFile</NAME>
+typedef struct {
+    GList *sections;
+} RcFile;
+</STRUCT>
+<FUNCTION>
+<NAME>bmp_rcfile_new</NAME>
+<RETURNS>RcFile *</RETURNS>
+void
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_rcfile_free</NAME>
+<RETURNS>void </RETURNS>
+RcFile * file
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_rcfile_open</NAME>
+<RETURNS>RcFile *</RETURNS>
+const gchar * filename
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_rcfile_write</NAME>
+<RETURNS>gboolean </RETURNS>
+RcFile * file, const gchar * filename
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_rcfile_read_string</NAME>
+<RETURNS>gboolean </RETURNS>
+RcFile * file, const gchar * section,const gchar * key, gchar ** value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_rcfile_read_int</NAME>
+<RETURNS>gboolean </RETURNS>
+RcFile * file, const gchar * section,const gchar * key, gint * value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_rcfile_read_bool</NAME>
+<RETURNS>gboolean </RETURNS>
+RcFile * file, const gchar * section,const gchar * key, gboolean * value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_rcfile_read_float</NAME>
+<RETURNS>gboolean </RETURNS>
+RcFile * file, const gchar * section,const gchar * key, gfloat * value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_rcfile_read_double</NAME>
+<RETURNS>gboolean </RETURNS>
+RcFile * file, const gchar * section,const gchar * key, gdouble * value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_rcfile_write_string</NAME>
+<RETURNS>void </RETURNS>
+RcFile * file, const gchar * section,const gchar * key, const gchar * value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_rcfile_write_int</NAME>
+<RETURNS>void </RETURNS>
+RcFile * file, const gchar * section,const gchar * key, gint value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_rcfile_write_boolean</NAME>
+<RETURNS>void </RETURNS>
+RcFile * file, const gchar * section,const gchar * key, gboolean value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_rcfile_write_float</NAME>
+<RETURNS>void </RETURNS>
+RcFile * file, const gchar * section,const gchar * key, gfloat value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_rcfile_write_double</NAME>
+<RETURNS>void </RETURNS>
+RcFile * file, const gchar * section,const gchar * key, gdouble value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_rcfile_remove_key</NAME>
+<RETURNS>void </RETURNS>
+RcFile * file, const gchar * section,const gchar * key
+</FUNCTION>
+<FUNCTION>
+<NAME>convert_free_buffer</NAME>
+<RETURNS>void </RETURNS>
+void
+</FUNCTION>
+<STRUCT>
+<NAME>xmms_convert_buffers</NAME>
+struct xmms_convert_buffers;
+</STRUCT>
+<STRUCT>
+<NAME>ConfigDb</NAME>
+</STRUCT>
+<FUNCTION>
+<NAME>bmp_cfg_db_open</NAME>
+<RETURNS>ConfigDb *</RETURNS>
+
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_cfg_db_close</NAME>
+<RETURNS>void </RETURNS>
+ConfigDb *db
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_cfg_db_get_string</NAME>
+<RETURNS>gboolean </RETURNS>
+ConfigDb *db,const gchar *section,const gchar *key,gchar **value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_cfg_db_get_int</NAME>
+<RETURNS>gboolean </RETURNS>
+ConfigDb *db,const gchar *section,const gchar *key,gint *value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_cfg_db_get_bool</NAME>
+<RETURNS>gboolean </RETURNS>
+ConfigDb *db,const gchar *section,const gchar *key,gboolean *value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_cfg_db_get_float</NAME>
+<RETURNS>gboolean </RETURNS>
+ConfigDb *db,const gchar *section,const gchar *key,gfloat *value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_cfg_db_get_double</NAME>
+<RETURNS>gboolean </RETURNS>
+ConfigDb *db,const gchar *section,const gchar *key,gdouble *value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_cfg_db_set_string</NAME>
+<RETURNS>void </RETURNS>
+ConfigDb *db,const gchar *section,const gchar *key,gchar *value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_cfg_db_set_int</NAME>
+<RETURNS>void </RETURNS>
+ConfigDb *db,const gchar *section,const gchar *key,gint value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_cfg_db_set_bool</NAME>
+<RETURNS>void </RETURNS>
+ConfigDb *db,const gchar *section,const gchar *key,gboolean value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_cfg_db_set_float</NAME>
+<RETURNS>void </RETURNS>
+ConfigDb *db,const gchar *section,const gchar *key,gfloat value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_cfg_db_set_double</NAME>
+<RETURNS>void </RETURNS>
+ConfigDb *db,const gchar *section,const gchar *key,gdouble value
+</FUNCTION>
+<FUNCTION>
+<NAME>bmp_cfg_db_unset_key</NAME>
+<RETURNS>void </RETURNS>
+ConfigDb *db,const gchar *section,const gchar *key
+</FUNCTION>
+<FUNCTION>
+<NAME>xmms_create_dir_browser</NAME>
+<RETURNS>GtkWidget *</RETURNS>
+gchar * title, gchar * current_path,GtkSelectionMode mode,void (*handler) (gchar *)
+</FUNCTION>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libaudacious/libaudacious-sections.txt	Mon Dec 04 13:25:25 2006 -0800
@@ -0,0 +1,175 @@
+<SECTION>
+<FILE>vfs</FILE>
+VFSFile
+VFSConstructor
+vfs_init
+vfs_fopen
+vfs_fclose
+vfs_fread
+vfs_fwrite
+vfs_getc
+vfs_ungetc
+vfs_fgets
+vfs_fseek
+vfs_rewind
+vfs_ftell
+vfs_feof
+vfs_file_test
+vfs_is_writeable
+vfs_truncate
+vfs_fprintf
+vfs_register_transport
+</SECTION>
+
+<SECTION>
+<FILE>beepctrl</FILE>
+xmms_connect_to_session
+xmms_remote_playlist
+xmms_remote_get_version
+xmms_remote_playlist_add
+xmms_remote_playlist_delete
+xmms_remote_play
+xmms_remote_pause
+xmms_remote_stop
+xmms_remote_is_playing
+xmms_remote_is_paused
+xmms_remote_get_playlist_pos
+xmms_remote_set_playlist_pos
+xmms_remote_get_playlist_length
+xmms_remote_playlist_clear
+xmms_remote_get_output_time
+xmms_remote_jump_to_time
+xmms_remote_get_volume
+xmms_remote_get_main_volume
+xmms_remote_get_balance
+xmms_remote_set_volume
+xmms_remote_set_main_volume
+xmms_remote_set_balance
+xmms_remote_get_skin
+xmms_remote_set_skin
+xmms_remote_get_playlist_file
+xmms_remote_get_playlist_title
+xmms_remote_get_playlist_time
+xmms_remote_get_info
+xmms_remote_main_win_toggle
+xmms_remote_pl_win_toggle
+xmms_remote_eq_win_toggle
+xmms_remote_is_main_win
+xmms_remote_is_pl_win
+xmms_remote_is_eq_win
+xmms_remote_show_prefs_box
+xmms_remote_toggle_aot
+xmms_remote_eject
+xmms_remote_playlist_prev
+xmms_remote_playlist_next
+xmms_remote_playlist_add_url_string
+xmms_remote_is_running
+xmms_remote_toggle_repeat
+xmms_remote_toggle_shuffle
+xmms_remote_is_repeat
+xmms_remote_is_shuffle
+xmms_remote_get_eq
+xmms_remote_get_eq_preamp
+xmms_remote_get_eq_band
+xmms_remote_set_eq
+xmms_remote_set_eq_preamp
+xmms_remote_set_eq_band
+xmms_remote_quit
+xmms_remote_play_pause
+xmms_remote_playlist_ins_url_string
+xmms_remote_playqueue_add
+xmms_remote_playqueue_remove
+xmms_remote_get_playqueue_length
+xmms_remote_toggle_advance
+xmms_remote_is_advance
+xmms_remote_activate
+xmms_remote_show_jtf_box
+xmms_remote_playqueue_clear
+xmms_remote_playqueue_is_queued
+xmms_remote_get_playqueue_position
+xmms_remote_get_playqueue_queue_position
+audacious_set_session_uri
+audacious_get_session_uri
+audacious_set_session_type
+xmms_remote_play_files
+xmms_remote_add_files
+</SECTION>
+
+<SECTION>
+<FILE>titlestring</FILE>
+TitleInput
+BmpTitleInput
+XMMS_TITLEINPUT_SIZE
+XMMS_TITLEINPUT_VERSION
+XMMS_NEW_TITLEINPUT
+bmp_title_input_new
+bmp_title_input_free
+xmms_get_titlestring
+xmms_titlestring_descriptions
+</SECTION>
+
+<SECTION>
+<FILE>formatter</FILE>
+Formatter
+xmms_formatter_new
+xmms_formatter_destroy
+xmms_formatter_associate
+xmms_formatter_dissociate
+xmms_formatter_format
+</SECTION>
+
+<SECTION>
+<FILE>rcfile</FILE>
+RcLine
+RcSection
+RcFile
+bmp_rcfile_new
+bmp_rcfile_free
+bmp_rcfile_open
+bmp_rcfile_write
+bmp_rcfile_read_string
+bmp_rcfile_read_int
+bmp_rcfile_read_bool
+bmp_rcfile_read_float
+bmp_rcfile_read_double
+bmp_rcfile_write_string
+bmp_rcfile_write_int
+bmp_rcfile_write_boolean
+bmp_rcfile_write_float
+bmp_rcfile_write_double
+bmp_rcfile_remove_key
+</SECTION>
+
+<SECTION>
+<FILE>xconvert</FILE>
+convert_free_buffer
+xmms_convert_buffers
+</SECTION>
+
+<SECTION>
+<FILE>configdb</FILE>
+ConfigDb
+bmp_cfg_db_open
+bmp_cfg_db_close
+bmp_cfg_db_get_string
+bmp_cfg_db_get_int
+bmp_cfg_db_get_bool
+bmp_cfg_db_get_float
+bmp_cfg_db_get_double
+bmp_cfg_db_set_string
+bmp_cfg_db_set_int
+bmp_cfg_db_set_bool
+bmp_cfg_db_set_float
+bmp_cfg_db_set_double
+bmp_cfg_db_unset_key
+</SECTION>
+
+<SECTION>
+<FILE>util</FILE>
+</SECTION>
+
+<SECTION>
+<FILE>dirbrowser</FILE>
+xmms_create_dir_browser
+</SECTION>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libaudacious/libaudacious-undocumented.txt	Mon Dec 04 13:25:25 2006 -0800
@@ -0,0 +1,62 @@
+70% symbol docs coverage.
+110 symbols documented.
+7 symbols incomplete.
+47 not documented.
+
+
+BmpTitleInput
+ConfigDb
+Formatter
+RcFile
+RcLine
+RcSection
+TitleInput
+VFSConstructor
+VFSFile
+XMMS_NEW_TITLEINPUT
+XMMS_TITLEINPUT_SIZE
+XMMS_TITLEINPUT_VERSION
+bmp_rcfile_free
+bmp_rcfile_new
+bmp_rcfile_open
+bmp_rcfile_read_bool
+bmp_rcfile_read_double
+bmp_rcfile_read_float
+bmp_rcfile_read_int
+bmp_rcfile_read_string
+bmp_rcfile_remove_key
+bmp_rcfile_write
+bmp_rcfile_write_boolean
+bmp_rcfile_write_double
+bmp_rcfile_write_float
+bmp_rcfile_write_int
+bmp_rcfile_write_string
+convert_free_buffer
+vfs_fgets
+vfs_fprintf
+vfs_fseek (offset, whence)
+vfs_ftell
+vfs_init
+vfs_is_writeable
+vfs_truncate (length)
+vfs_ungetc (c)
+xmms_convert_buffers
+xmms_create_dir_browser
+xmms_formatter_new (Returns)
+xmms_remote_add_files
+xmms_remote_playqueue_add (pos)
+xmms_remote_playqueue_remove (pos)
+xmms_titlestring_descriptions (rows)
+
+
+beepctrl:Long_Description
+configdb:Long_Description
+dirbrowser:Short_Description
+formatter:Long_Description
+rcfile:Long_Description
+rcfile:Short_Description
+titlestring:Long_Description
+util:Long_Description
+util:Short_Description
+xconvert:Long_Description
+xconvert:Short_Description
--- a/doc/libaudacious/tmpl/util.sgml	Mon Dec 04 02:18:02 2006 -0800
+++ b/doc/libaudacious/tmpl/util.sgml	Mon Dec 04 13:25:25 2006 -0800
@@ -1,8 +1,8 @@
 <!-- ##### SECTION Title ##### -->
-util
+Miscillaneous Utility Functions
 
 <!-- ##### SECTION Short_Description ##### -->
-
+MessageBoxes, sleeping.
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
--- a/libaudacious/util.c	Mon Dec 04 02:18:02 2006 -0800
+++ b/libaudacious/util.c	Mon Dec 04 13:25:25 2006 -0800
@@ -1,3 +1,26 @@
+/*  Audacious
+ *  Copyright (C) 2005-2007  Audacious team
+ *
+ *  XMMS - Cross-platform multimedia player
+ *  Copyright (C) 1998-2003  Peter Alm, Mikael Alm, Olle Hallnas,
+ *                           Thomas Nilsson and 4Front Technologies
+ *  Copyright (C) 1999-2003  Haavard Kvaalen
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+
 #ifdef HAVE_CONFIG_H
 #  include "config.h"
 #endif
@@ -5,7 +28,19 @@
 #include <glib.h>
 #include <gtk/gtk.h>
 
-
+/**
+ * xmms_show_message:
+ * @title: The title of the message to show.
+ * @text: The text of the message to show.
+ * @button_text: The text of the button which will close the messagebox.
+ * @modal: Whether or not the messagebox should be modal.
+ * @button_action: Code to execute on when the messagebox is closed, or %NULL.
+ * @action_data: Optional opaque data to pass to @button_action.
+ *
+ * Displays a message box.
+ *
+ * Return value: A GTK widget handle for the message box.
+ **/
 GtkWidget *
 xmms_show_message(const gchar * title, const gchar * text,
                   const gchar * button_text, gboolean modal,
@@ -58,12 +93,25 @@
   return dialog;
 }
 
+/**
+ * xmms_check_realtime_priority:
+ *
+ * Legacy function included for compatibility with XMMS.
+ *
+ * Return value: FALSE
+ **/
 gboolean
 xmms_check_realtime_priority(void)
 {
     return FALSE;
 }
 
+/**
+ * xmms_usleep:
+ * @usec: The amount of microseconds to sleep.
+ *
+ * Legacy function included for compatibility with XMMS.
+ **/
 void
 xmms_usleep(gint usec)
 {