Mercurial > audlegacy

changeset 2034:c43fb0845b71 trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[svn] - update VFS documentation - include gtkdoc templates for libaudacious
author nenolod
date Mon, 04 Dec 2006 00:10:02 -0800
parents 34299070db29
children bf9198617dae
files ChangeLog doc/libaudacious/tmpl/beepctrl.sgml doc/libaudacious/tmpl/configdb.sgml doc/libaudacious/tmpl/dirbrowser.sgml doc/libaudacious/tmpl/formatter.sgml doc/libaudacious/tmpl/libaudacious-unused.sgml doc/libaudacious/tmpl/rcfile.sgml doc/libaudacious/tmpl/titlestring.sgml doc/libaudacious/tmpl/util.sgml doc/libaudacious/tmpl/vfs.sgml doc/libaudacious/tmpl/xconvert.sgml doc/libaudacious/tmpl/xentry.sgml doc/libaudacious/tmpl/xml_document.sgml libaudacious/vfs.c
diffstat 13 files changed, 1837 insertions(+), 189 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog	Sun Dec 03 23:26:42 2006 -0800
+++ b/ChangeLog	Mon Dec 04 00:10:02 2006 -0800
@@ -1,3 +1,11 @@
+2006-12-04 07:26:42 +0000  William Pitcock <nenolod@nenolod.net>
+  revision [3069]
+  - make documentation-build will invoke gtk-doc to compile the audacious SDK docs.
+  
+  trunk/Makefile |   48 ++++++++++++++++++++++++++++++++++++++++++++++++
+  1 file changed, 48 insertions(+)
+
+
 2006-12-04 06:35:18 +0000  William Pitcock <nenolod@nenolod.net>
   revision [3067]
   - document the VFS layer.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libaudacious/tmpl/beepctrl.sgml	Mon Dec 04 00:10:02 2006 -0800
@@ -0,0 +1,648 @@
+<!-- ##### SECTION Title ##### -->
+beepctrl
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION xmms_connect_to_session ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_playlist ##### -->
+<para>
+
+</para>
+
+@session: 
+@list: 
+@num: 
+@enqueue: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_version ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_playlist_add ##### -->
+<para>
+
+</para>
+
+@session: 
+@list: 
+
+
+<!-- ##### FUNCTION xmms_remote_playlist_delete ##### -->
+<para>
+
+</para>
+
+@session: 
+@pos: 
+
+
+<!-- ##### FUNCTION xmms_remote_play ##### -->
+<para>
+
+</para>
+
+@session: 
+
+
+<!-- ##### FUNCTION xmms_remote_pause ##### -->
+<para>
+
+</para>
+
+@session: 
+
+
+<!-- ##### FUNCTION xmms_remote_stop ##### -->
+<para>
+
+</para>
+
+@session: 
+
+
+<!-- ##### FUNCTION xmms_remote_is_playing ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_is_paused ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_playlist_pos ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_set_playlist_pos ##### -->
+<para>
+
+</para>
+
+@session: 
+@pos: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_playlist_length ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_playlist_clear ##### -->
+<para>
+
+</para>
+
+@session: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_output_time ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_jump_to_time ##### -->
+<para>
+
+</para>
+
+@session: 
+@pos: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_volume ##### -->
+<para>
+
+</para>
+
+@session: 
+@vl: 
+@vr: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_main_volume ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_balance ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_set_volume ##### -->
+<para>
+
+</para>
+
+@session: 
+@vl: 
+@vr: 
+
+
+<!-- ##### FUNCTION xmms_remote_set_main_volume ##### -->
+<para>
+
+</para>
+
+@session: 
+@v: 
+
+
+<!-- ##### FUNCTION xmms_remote_set_balance ##### -->
+<para>
+
+</para>
+
+@session: 
+@b: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_skin ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_set_skin ##### -->
+<para>
+
+</para>
+
+@session: 
+@skinfile: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_playlist_file ##### -->
+<para>
+
+</para>
+
+@session: 
+@pos: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_playlist_title ##### -->
+<para>
+
+</para>
+
+@session: 
+@pos: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_playlist_time ##### -->
+<para>
+
+</para>
+
+@session: 
+@pos: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_info ##### -->
+<para>
+
+</para>
+
+@session: 
+@rate: 
+@freq: 
+@nch: 
+
+
+<!-- ##### FUNCTION xmms_remote_main_win_toggle ##### -->
+<para>
+
+</para>
+
+@session: 
+@show: 
+
+
+<!-- ##### FUNCTION xmms_remote_pl_win_toggle ##### -->
+<para>
+
+</para>
+
+@session: 
+@show: 
+
+
+<!-- ##### FUNCTION xmms_remote_eq_win_toggle ##### -->
+<para>
+
+</para>
+
+@session: 
+@show: 
+
+
+<!-- ##### FUNCTION xmms_remote_is_main_win ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_is_pl_win ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_is_eq_win ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_show_prefs_box ##### -->
+<para>
+
+</para>
+
+@session: 
+
+
+<!-- ##### FUNCTION xmms_remote_toggle_aot ##### -->
+<para>
+
+</para>
+
+@session: 
+@ontop: 
+
+
+<!-- ##### FUNCTION xmms_remote_eject ##### -->
+<para>
+
+</para>
+
+@session: 
+
+
+<!-- ##### FUNCTION xmms_remote_playlist_prev ##### -->
+<para>
+
+</para>
+
+@session: 
+
+
+<!-- ##### FUNCTION xmms_remote_playlist_next ##### -->
+<para>
+
+</para>
+
+@session: 
+
+
+<!-- ##### FUNCTION xmms_remote_playlist_add_url_string ##### -->
+<para>
+
+</para>
+
+@session: 
+@string: 
+
+
+<!-- ##### FUNCTION xmms_remote_is_running ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_toggle_repeat ##### -->
+<para>
+
+</para>
+
+@session: 
+
+
+<!-- ##### FUNCTION xmms_remote_toggle_shuffle ##### -->
+<para>
+
+</para>
+
+@session: 
+
+
+<!-- ##### FUNCTION xmms_remote_is_repeat ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_is_shuffle ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_eq ##### -->
+<para>
+
+</para>
+
+@session: 
+@preamp: 
+@bands: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_eq_preamp ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_eq_band ##### -->
+<para>
+
+</para>
+
+@session: 
+@band: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_set_eq ##### -->
+<para>
+
+</para>
+
+@session: 
+@preamp: 
+@bands: 
+
+
+<!-- ##### FUNCTION xmms_remote_set_eq_preamp ##### -->
+<para>
+
+</para>
+
+@session: 
+@preamp: 
+
+
+<!-- ##### FUNCTION xmms_remote_set_eq_band ##### -->
+<para>
+
+</para>
+
+@session: 
+@band: 
+@value: 
+
+
+<!-- ##### FUNCTION xmms_remote_quit ##### -->
+<para>
+
+</para>
+
+@session: 
+
+
+<!-- ##### FUNCTION xmms_remote_play_pause ##### -->
+<para>
+
+</para>
+
+@session: 
+
+
+<!-- ##### FUNCTION xmms_remote_playlist_ins_url_string ##### -->
+<para>
+
+</para>
+
+@session: 
+@string: 
+@pos: 
+
+
+<!-- ##### FUNCTION xmms_remote_playqueue_add ##### -->
+<para>
+
+</para>
+
+@session: 
+@pos: 
+
+
+<!-- ##### FUNCTION xmms_remote_playqueue_remove ##### -->
+<para>
+
+</para>
+
+@session: 
+@pos: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_playqueue_length ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_toggle_advance ##### -->
+<para>
+
+</para>
+
+@session: 
+
+
+<!-- ##### FUNCTION xmms_remote_is_advance ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_activate ##### -->
+<para>
+
+</para>
+
+@session: 
+
+
+<!-- ##### FUNCTION xmms_remote_show_jtf_box ##### -->
+<para>
+
+</para>
+
+@session: 
+
+
+<!-- ##### FUNCTION xmms_remote_playqueue_clear ##### -->
+<para>
+
+</para>
+
+@session: 
+
+
+<!-- ##### FUNCTION xmms_remote_playqueue_is_queued ##### -->
+<para>
+
+</para>
+
+@session: 
+@pos: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_playqueue_position ##### -->
+<para>
+
+</para>
+
+@session: 
+@pos: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_remote_get_playqueue_queue_position ##### -->
+<para>
+
+</para>
+
+@session: 
+@pos: 
+@Returns: 
+
+
+<!-- ##### FUNCTION audacious_set_session_uri ##### -->
+<para>
+
+</para>
+
+@uri: 
+
+
+<!-- ##### FUNCTION audacious_get_session_uri ##### -->
+<para>
+
+</para>
+
+@session: 
+@Returns: 
+
+
+<!-- ##### FUNCTION audacious_set_session_type ##### -->
+<para>
+
+</para>
+
+@type: 
+
+
+<!-- ##### FUNCTION xmms_remote_play_files ##### -->
+<para>
+
+</para>
+
+@session: 
+@list: 
+
+
+<!-- ##### MACRO xmms_remote_add_files ##### -->
+<para>
+
+</para>
+
+@session: 
+@list: 
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libaudacious/tmpl/configdb.sgml	Mon Dec 04 00:10:02 2006 -0800
@@ -0,0 +1,166 @@
+<!-- ##### SECTION Title ##### -->
+configdb
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT ConfigDb ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION bmp_cfg_db_open ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_cfg_db_close ##### -->
+<para>
+
+</para>
+
+@db: 
+
+
+<!-- ##### FUNCTION bmp_cfg_db_get_string ##### -->
+<para>
+
+</para>
+
+@db: 
+@section: 
+@key: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_cfg_db_get_int ##### -->
+<para>
+
+</para>
+
+@db: 
+@section: 
+@key: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_cfg_db_get_bool ##### -->
+<para>
+
+</para>
+
+@db: 
+@section: 
+@key: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_cfg_db_get_float ##### -->
+<para>
+
+</para>
+
+@db: 
+@section: 
+@key: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_cfg_db_get_double ##### -->
+<para>
+
+</para>
+
+@db: 
+@section: 
+@key: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_cfg_db_set_string ##### -->
+<para>
+
+</para>
+
+@db: 
+@section: 
+@key: 
+@value: 
+
+
+<!-- ##### FUNCTION bmp_cfg_db_set_int ##### -->
+<para>
+
+</para>
+
+@db: 
+@section: 
+@key: 
+@value: 
+
+
+<!-- ##### FUNCTION bmp_cfg_db_set_bool ##### -->
+<para>
+
+</para>
+
+@db: 
+@section: 
+@key: 
+@value: 
+
+
+<!-- ##### FUNCTION bmp_cfg_db_set_float ##### -->
+<para>
+
+</para>
+
+@db: 
+@section: 
+@key: 
+@value: 
+
+
+<!-- ##### FUNCTION bmp_cfg_db_set_double ##### -->
+<para>
+
+</para>
+
+@db: 
+@section: 
+@key: 
+@value: 
+
+
+<!-- ##### FUNCTION bmp_cfg_db_unset_key ##### -->
+<para>
+
+</para>
+
+@db: 
+@section: 
+@key: 
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libaudacious/tmpl/dirbrowser.sgml	Mon Dec 04 00:10:02 2006 -0800
@@ -0,0 +1,31 @@
+<!-- ##### SECTION Title ##### -->
+dirbrowser
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION xmms_create_dir_browser ##### -->
+<para>
+
+</para>
+
+@title: 
+@current_path: 
+@mode: 
+@handler: 
+@Returns: 
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libaudacious/tmpl/formatter.sgml	Mon Dec 04 00:10:02 2006 -0800
@@ -0,0 +1,71 @@
+<!-- ##### SECTION Title ##### -->
+formatter
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT Formatter ##### -->
+<para>
+
+</para>
+
+@values: 
+
+<!-- ##### FUNCTION xmms_formatter_new ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_formatter_destroy ##### -->
+<para>
+
+</para>
+
+@formatter: 
+
+
+<!-- ##### FUNCTION xmms_formatter_associate ##### -->
+<para>
+
+</para>
+
+@formatter: 
+@id: 
+@value: 
+
+
+<!-- ##### FUNCTION xmms_formatter_dissociate ##### -->
+<para>
+
+</para>
+
+@formatter: 
+@id: 
+
+
+<!-- ##### FUNCTION xmms_formatter_format ##### -->
+<para>
+
+</para>
+
+@formatter: 
+@format: 
+@Returns: 
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libaudacious/tmpl/rcfile.sgml	Mon Dec 04 00:10:02 2006 -0800
@@ -0,0 +1,202 @@
+<!-- ##### SECTION Title ##### -->
+rcfile
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT RcLine ##### -->
+<para>
+
+</para>
+
+@key: 
+@value: 
+
+<!-- ##### STRUCT RcSection ##### -->
+<para>
+
+</para>
+
+@name: 
+@lines: 
+
+<!-- ##### STRUCT RcFile ##### -->
+<para>
+
+</para>
+
+@sections: 
+
+<!-- ##### FUNCTION bmp_rcfile_new ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_rcfile_free ##### -->
+<para>
+
+</para>
+
+@file: 
+
+
+<!-- ##### FUNCTION bmp_rcfile_open ##### -->
+<para>
+
+</para>
+
+@filename: 
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_rcfile_write ##### -->
+<para>
+
+</para>
+
+@file: 
+@filename: 
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_rcfile_read_string ##### -->
+<para>
+
+</para>
+
+@file: 
+@section: 
+@key: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_rcfile_read_int ##### -->
+<para>
+
+</para>
+
+@file: 
+@section: 
+@key: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_rcfile_read_bool ##### -->
+<para>
+
+</para>
+
+@file: 
+@section: 
+@key: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_rcfile_read_float ##### -->
+<para>
+
+</para>
+
+@file: 
+@section: 
+@key: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_rcfile_read_double ##### -->
+<para>
+
+</para>
+
+@file: 
+@section: 
+@key: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_rcfile_write_string ##### -->
+<para>
+
+</para>
+
+@file: 
+@section: 
+@key: 
+@value: 
+
+
+<!-- ##### FUNCTION bmp_rcfile_write_int ##### -->
+<para>
+
+</para>
+
+@file: 
+@section: 
+@key: 
+@value: 
+
+
+<!-- ##### FUNCTION bmp_rcfile_write_boolean ##### -->
+<para>
+
+</para>
+
+@file: 
+@section: 
+@key: 
+@value: 
+
+
+<!-- ##### FUNCTION bmp_rcfile_write_float ##### -->
+<para>
+
+</para>
+
+@file: 
+@section: 
+@key: 
+@value: 
+
+
+<!-- ##### FUNCTION bmp_rcfile_write_double ##### -->
+<para>
+
+</para>
+
+@file: 
+@section: 
+@key: 
+@value: 
+
+
+<!-- ##### FUNCTION bmp_rcfile_remove_key ##### -->
+<para>
+
+</para>
+
+@file: 
+@section: 
+@key: 
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libaudacious/tmpl/titlestring.sgml	Mon Dec 04 00:10:02 2006 -0800
@@ -0,0 +1,105 @@
+<!-- ##### SECTION Title ##### -->
+titlestring
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT TitleInput ##### -->
+<para>
+
+</para>
+
+@__size: 
+@__version: 
+@performer: 
+@album_name: 
+@track_name: 
+@track_number: 
+@year: 
+@date: 
+@genre: 
+@comment: 
+@file_name: 
+@file_ext: 
+@file_path: 
+@length: 
+@formatter: 
+@mtime: 
+
+<!-- ##### TYPEDEF BmpTitleInput ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO XMMS_TITLEINPUT_SIZE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO XMMS_TITLEINPUT_VERSION ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO XMMS_NEW_TITLEINPUT ##### -->
+<para>
+
+</para>
+
+@input: 
+
+
+<!-- ##### FUNCTION bmp_title_input_new ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_title_input_free ##### -->
+<para>
+
+</para>
+
+@input: 
+
+
+<!-- ##### FUNCTION xmms_get_titlestring ##### -->
+<para>
+
+</para>
+
+@fmt: 
+@input: 
+@Returns: 
+
+
+<!-- ##### FUNCTION xmms_titlestring_descriptions ##### -->
+<para>
+
+</para>
+
+@tags: 
+@rows: 
+@Returns: 
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libaudacious/tmpl/util.sgml	Mon Dec 04 00:10:02 2006 -0800
@@ -0,0 +1,19 @@
+<!-- ##### SECTION Title ##### -->
+util
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libaudacious/tmpl/vfs.sgml	Mon Dec 04 00:10:02 2006 -0800
@@ -0,0 +1,213 @@
+<!-- ##### SECTION Title ##### -->
+VFS
+
+<!-- ##### SECTION Short_Description ##### -->
+Stream-based I/O in Audacious
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+Audacious uses the VFS subsystem for moving implementing types of streams.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT VFSFile ##### -->
+<para>
+
+</para>
+
+@uri: 
+@handle: 
+@base: 
+
+<!-- ##### STRUCT VFSConstructor ##### -->
+<para>
+
+</para>
+
+@uri_id: 
+@vfs_fopen_impl: 
+@vfs_fclose_impl: 
+@vfs_fread_impl: 
+@vfs_fwrite_impl: 
+@vfs_getc_impl: 
+@vfs_ungetc_impl: 
+@vfs_fseek_impl: 
+@vfs_rewind_impl: 
+@vfs_ftell_impl: 
+@vfs_feof_impl: 
+@vfs_truncate_impl: 
+
+<!-- ##### FUNCTION vfs_init ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION vfs_fopen ##### -->
+<para>
+
+</para>
+
+@path: 
+@mode: 
+@Returns: 
+
+
+<!-- ##### FUNCTION vfs_fclose ##### -->
+<para>
+
+</para>
+
+@file: 
+@Returns: 
+
+
+<!-- ##### FUNCTION vfs_fread ##### -->
+<para>
+
+</para>
+
+@ptr: 
+@size: 
+@nmemb: 
+@file: 
+@Returns: 
+
+
+<!-- ##### FUNCTION vfs_fwrite ##### -->
+<para>
+
+</para>
+
+@ptr: 
+@size: 
+@nmemb: 
+@file: 
+@Returns: 
+
+
+<!-- ##### FUNCTION vfs_getc ##### -->
+<para>
+
+</para>
+
+@stream: 
+@Returns: 
+
+
+<!-- ##### FUNCTION vfs_ungetc ##### -->
+<para>
+
+</para>
+
+@c: 
+@stream: 
+@Returns: 
+
+
+<!-- ##### FUNCTION vfs_fgets ##### -->
+<para>
+
+</para>
+
+@s: 
+@n: 
+@stream: 
+@Returns: 
+
+
+<!-- ##### FUNCTION vfs_fseek ##### -->
+<para>
+
+</para>
+
+@file: 
+@offset: 
+@whence: 
+@Returns: 
+
+
+<!-- ##### FUNCTION vfs_rewind ##### -->
+<para>
+
+</para>
+
+@file: 
+
+
+<!-- ##### FUNCTION vfs_ftell ##### -->
+<para>
+
+</para>
+
+@file: 
+@Returns: 
+
+
+<!-- ##### FUNCTION vfs_feof ##### -->
+<para>
+
+</para>
+
+@file: 
+@Returns: 
+
+
+<!-- ##### FUNCTION vfs_file_test ##### -->
+<para>
+
+</para>
+
+@path: 
+@test: 
+@Returns: 
+
+
+<!-- ##### FUNCTION vfs_is_writeable ##### -->
+<para>
+
+</para>
+
+@path: 
+@Returns: 
+
+
+<!-- ##### FUNCTION vfs_truncate ##### -->
+<para>
+
+</para>
+
+@file: 
+@length: 
+@Returns: 
+
+
+<!-- ##### FUNCTION vfs_fprintf ##### -->
+<para>
+
+</para>
+
+@stream: 
+@format: 
+@Varargs: 
+@Returns: 
+
+
+<!-- ##### FUNCTION vfs_register_transport ##### -->
+<para>
+
+</para>
+
+@vtable: 
+@Returns: 
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libaudacious/tmpl/xconvert.sgml	Mon Dec 04 00:10:02 2006 -0800
@@ -0,0 +1,32 @@
+<!-- ##### SECTION Title ##### -->
+xconvert
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION convert_free_buffer ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### STRUCT xmms_convert_buffers ##### -->
+<para>
+
+</para>
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libaudacious/tmpl/xentry.sgml	Mon Dec 04 00:10:02 2006 -0800
@@ -0,0 +1,34 @@
+<!-- ##### SECTION Title ##### -->
+XmmsEntry
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT XmmsEntry ##### -->
+<para>
+
+</para>
+
+@entry: 
+
+<!-- ##### FUNCTION xmms_entry_new ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/libaudacious/tmpl/xml_document.sgml	Mon Dec 04 00:10:02 2006 -0800
@@ -0,0 +1,224 @@
+<!-- ##### SECTION Title ##### -->
+xml_document
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### ENUM BmpXmlNodeType ##### -->
+<para>
+
+</para>
+
+@BMP_XML_NODE_DOC: 
+@BMP_XML_NODE_ELEMENT: 
+@BMP_XML_NODE_ATTRIB: 
+@BMP_XML_NODE_TEXT: 
+
+<!-- ##### MACRO BMP_XML_DOCUMENT ##### -->
+<para>
+
+</para>
+
+@x: 
+
+
+<!-- ##### STRUCT BmpXmlDocument ##### -->
+<para>
+
+</para>
+
+@tree: 
+@current_node: 
+@current_depth: 
+@parse_context: 
+
+<!-- ##### MACRO BMP_XML_NODE_DATA ##### -->
+<para>
+
+</para>
+
+@x: 
+
+
+<!-- ##### STRUCT BmpXmlNodeData ##### -->
+<para>
+
+</para>
+
+@type: 
+
+<!-- ##### MACRO BMP_XML_DOC_NODE_DATA ##### -->
+<para>
+
+</para>
+
+@x: 
+
+
+<!-- ##### STRUCT BmpXmlDocNodeData ##### -->
+<para>
+
+</para>
+
+@type: 
+
+<!-- ##### MACRO BMP_XML_ELEMENT_NODE_DATA ##### -->
+<para>
+
+</para>
+
+@x: 
+
+
+<!-- ##### STRUCT BmpXmlElementNodeData ##### -->
+<para>
+
+</para>
+
+@type: 
+@name: 
+
+<!-- ##### MACRO BMP_XML_ATTRIB_NODE_DATA ##### -->
+<para>
+
+</para>
+
+@x: 
+
+
+<!-- ##### STRUCT BmpXmlAttribNodeData ##### -->
+<para>
+
+</para>
+
+@type: 
+@name: 
+@value: 
+
+<!-- ##### MACRO BMP_XML_TEXT_NODE_DATA ##### -->
+<para>
+
+</para>
+
+@x: 
+
+
+<!-- ##### STRUCT BmpXmlTextNodeData ##### -->
+<para>
+
+</para>
+
+@type: 
+@text: 
+@length: 
+
+<!-- ##### FUNCTION bmp_xml_doc_node_new ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_xml_doc_node_data_free ##### -->
+<para>
+
+</para>
+
+@data: 
+
+
+<!-- ##### FUNCTION bmp_xml_element_node_new ##### -->
+<para>
+
+</para>
+
+@name: 
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_xml_element_node_data_free ##### -->
+<para>
+
+</para>
+
+@data: 
+
+
+<!-- ##### FUNCTION bmp_xml_attrib_node_new ##### -->
+<para>
+
+</para>
+
+@name: 
+@value: 
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_xml_attrib_node_data_free ##### -->
+<para>
+
+</para>
+
+@data: 
+
+
+<!-- ##### FUNCTION bmp_xml_text_node_data_free ##### -->
+<para>
+
+</para>
+
+@data: 
+
+
+<!-- ##### FUNCTION bmp_xml_text_node_new ##### -->
+<para>
+
+</para>
+
+@text: 
+@length: 
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_xml_document_load ##### -->
+<para>
+
+</para>
+
+@document: 
+@filename: 
+@error: 
+@Returns: 
+
+
+<!-- ##### FUNCTION bmp_xml_document_free ##### -->
+<para>
+
+</para>
+
+@document: 
+
+
+<!-- ##### FUNCTION bmp_xml_document_get_tree ##### -->
+<para>
+
+</para>
+
+@document: 
+@Returns: 
+
+
--- a/libaudacious/vfs.c	Sun Dec 03 23:26:42 2006 -0800
+++ b/libaudacious/vfs.c	Mon Dec 04 00:10:02 2006 -0800
@@ -31,20 +31,14 @@
 # define DBG(x, args...)
 #endif
 
-/*
- * vfs_register_transport(VFSConstructor *vtable)
- *
- * Registers a VFSConstructor vtable with the VFS system.
+/**
+ * vfs_register_transport:
+ * @vtable: The #VFSConstructor vtable to register.
  *
- * Inputs:
- *     - a VFSConstructor object
+ * Registers a #VFSConstructor vtable with the VFS system.
  *
- * Outputs:
- *     - TRUE on success, FALSE on failure.
- *
- * Side Effects:
- *     - none
- */
+ * Return value: TRUE on success, FALSE on failure.
+ **/
 gboolean
 vfs_register_transport(VFSConstructor *vtable)
 {
@@ -53,22 +47,15 @@
     return TRUE;
 }
 
-/*
- * vfs_fopen(const gchar * path, const gchar * mode)
- *
- * Opens a stream from a VFS transport using a VFSConstructor.
+/**
+ * vfs_fopen:
+ * @path: The path or URI to open.
+ * @mode: The preferred access privileges (not guaranteed).
  *
- * Inputs:
- *     - path or URI to open
- *     - preferred access privileges (not guaranteed)
+ * Opens a stream from a VFS transport using a #VFSConstructor.
  *
- * Outputs:
- *     - on success, a VFSFile object representing the VFS stream
- *     - on failure, nothing
- *
- * Side Effects:
- *     - file descriptors are opened or more memory is allocated.
- */
+ * Return value: On success, a #VFSFile object representing the stream.
+ **/
 VFSFile *
 vfs_fopen(const gchar * path,
           const gchar * mode)
@@ -128,20 +115,14 @@
     return file;
 }
 
-/*
- * vfs_fclose(VFSFile * file)
- *
- * Closes a VFS stream and destroys a VFSFile object.
+/**
+ * vfs_fclose:
+ * @file: A #VFSFile object to destroy.
  *
- * Inputs:
- *     - a VFSFile object to destroy
+ * Closes a VFS stream and destroys a #VFSFile object.
  *
- * Outputs:
- *     - -1 on success, otherwise 0
- *
- * Side Effects:
- *     - a file description is closed or allocated memory is freed
- */
+ * Return value: -1 on failure, 0 on success.
+ **/
 gint
 vfs_fclose(VFSFile * file)
 {
@@ -161,25 +142,17 @@
     return ret;
 }
 
-/*
- * vfs_fread(gpointer ptr, size_t size, size_t nmemb, VFSFile * file)
+/**
+ * vfs_fread:
+ * @ptr: A pointer to the destination buffer.
+ * @size: The size of each element to read.
+ * @nmemb: The number of elements to read.
+ * @file: #VFSFile object that represents the VFS stream.
  *
  * Reads from a VFS stream.
  *
- * Inputs:
- *     - pointer to destination buffer
- *     - size of each element to read
- *     - number of elements to read
- *     - VFSFile object that represents the VFS stream
- *
- * Outputs:
- *     - on success, the amount of elements successfully read
- *     - on failure, -1
- *
- * Side Effects:
- *     - on nonblocking sources, the socket may be unavailable after 
- *       this call.
- */
+ * Return value: The amount of elements succesfully read.
+ **/
 size_t
 vfs_fread(gpointer ptr,
           size_t size,
@@ -192,25 +165,17 @@
     return file->base->vfs_fread_impl(ptr, size, nmemb, file);
 }
 
-/*
- * vfs_fwrite(gconstpointer ptr, size_t size, size_t nmemb, VFSFile * file)
+/**
+ * vfs_fwrite:
+ * @ptr: A const pointer to the source buffer.
+ * @size: The size of each element to write.
+ * @nmemb: The number of elements to write.
+ * @file: #VFSFile object that represents the VFS stream.
  *
  * Writes to a VFS stream.
  *
- * Inputs:
- *     - const pointer to source buffer
- *     - size of each element to write
- *     - number of elements to write
- *     - VFSFile object that represents the VFS stream
- *
- * Outputs:
- *     - on success, the amount of elements successfully written
- *     - on failure, -1
- *
- * Side Effects:
- *     - on nonblocking sources, the socket may be unavailable after 
- *       this call.
- */
+ * Return value: The amount of elements succesfully written.
+ **/
 size_t
 vfs_fwrite(gconstpointer ptr,
            size_t size,
@@ -223,22 +188,14 @@
     return file->base->vfs_fwrite_impl(ptr, size, nmemb, file);
 }
 
-/*
- * vfs_getc(VFSFile *stream)
+/**
+ * vfs_getc:
+ * @stream: #VFSFile object that represents the VFS stream.
  *
  * Reads a character from a VFS stream.
  *
- * Inputs:
- *     - a VFSFile object representing a VFS stream.
- *
- * Outputs:
- *     - on success, a character
- *     - on failure, -1
- *
- * Side Effects:
- *     - on nonblocking sources, the socket may be unavailable after 
- *       this call.
- */
+ * Return value: On success, a character. Otherwise, -1.
+ **/
 gint
 vfs_getc(VFSFile *stream)
 {
@@ -248,23 +205,14 @@
     return stream->base->vfs_getc_impl(stream);
 }
 
-/*
- * vfs_ungetc(gint c, VFSFile *stream)
+/**
+ * vfs_ungetc:
+ * @stream: #VFSFile object that represents the VFS stream.
  *
  * Pushes a character back to the VFS stream.
  *
- * Inputs:
- *     - a character to push back
- *     - a VFSFile object representing a VFS stream.
- *
- * Outputs:
- *     - on success, 0
- *     - on failure, -1
- *
- * Side Effects:
- *     - on nonblocking sources, the socket may be unavailable after 
- *       this call.
- */
+ * Return value: On success, 0. Otherwise, -1.
+ **/
 gint
 vfs_ungetc(gint c, VFSFile *stream)
 {
@@ -274,23 +222,16 @@
     return stream->base->vfs_ungetc_impl(c, stream);
 }
 
-/*
- * vfs_fseek(VFSFile * file, gint offset, gint whence)
+/**
+ * vfs_fseek:
+ * @file: #VFSFile object that represents the VFS stream.
+ * @offset: The offset to seek to.
+ * @whence: Whether or not the seek is absolute or not.
  *
  * Seeks through a VFS stream.
  *
- * Inputs:
- *     - a VFSFile object which represents a VFS stream
- *     - the offset to seek
- *     - whether or not the seek is absolute or non-absolute
- *
- * Outputs:
- *     - on success, 1
- *     - on failure, 0
- *
- * Side Effects:
- *     - on nonblocking sources, this is not guaranteed to work
- */
+ * Return value: On success, 1. Otherwise, 0.
+ **/
 gint
 vfs_fseek(VFSFile * file,
           glong offset,
@@ -302,20 +243,12 @@
     return file->base->vfs_fseek_impl(file, offset, whence);
 }
 
-/*
- * vfs_rewind(VFSFile * file)
+/**
+ * vfs_rewind:
+ * @file: #VFSFile object that represents the VFS stream.
  *
  * Rewinds a VFS stream.
- *
- * Inputs:
- *     - a VFSFile object which represents a VFS stream
- *
- * Outputs:
- *     - nothing
- *
- * Side Effects:
- *     - on nonblocking sources, this is not guaranteed to work
- */
+ **/
 void
 vfs_rewind(VFSFile * file)
 {
@@ -325,21 +258,14 @@
     file->base->vfs_rewind_impl(file);
 }
 
-/*
- * vfs_ftell(VFSFile * file)
- *
- * Returns the position of a VFS stream.
- *
- * Inputs:
- *     - a VFSFile object which represents a VFS stream
+/**
+ * vfs_fseek:
+ * @file: #VFSFile object that represents the VFS stream.
  *
- * Outputs:
- *     - on failure, -1.
- *     - on success, the stream's position
+ * Returns the current position in the VFS stream's buffer.
  *
- * Side Effects:
- *     - on nonblocking sources, this is not guaranteed to work
- */
+ * Return value: On success, the current position. Otherwise, -1.
+ **/
 glong
 vfs_ftell(VFSFile * file)
 {
@@ -349,21 +275,14 @@
     return file->base->vfs_ftell_impl(file);
 }
 
-/*
- * vfs_feof(VFSFile * file)
+/**
+ * vfs_feof:
+ * @file: #VFSFile object that represents the VFS stream.
  *
  * Returns whether or not the VFS stream has reached EOF.
  *
- * Inputs:
- *     - a VFSFile object which represents a VFS stream
- *
- * Outputs:
- *     - on failure, FALSE.
- *     - on success, whether or not the VFS stream is at EOF.
- *
- * Side Effects:
- *     - none
- */
+ * Return value: On success, whether or not the VFS stream is at EOF. Otherwise, FALSE.
+ **/
 gboolean
 vfs_feof(VFSFile * file)
 {
@@ -373,23 +292,15 @@
     return (gboolean) file->base->vfs_feof_impl(file);
 }
 
-/*
- * vfs_truncate(VFSFile * file, glong size)
+/**
+ * vfs_truncate:
+ * @file: #VFSFile object that represents the VFS stream.
+ * @size: The length to truncate at.
  *
  * Truncates a VFS stream to a certain size.
  *
- * Inputs:
- *     - a VFS stream to truncate
- *     - length to truncate at
- *
- * Outputs:
- *     - -1 on failure
- *     - 0 on success
- *
- * Side Effects:
- *     - this is not guaranteed to work on non-blocking
- *       sources
- */
+ * Return value: On success, 0. Otherwise, -1.
+ **/
 gint
 vfs_truncate(VFSFile * file, glong size)
 {
@@ -399,45 +310,29 @@
     return file->base->vfs_truncate_impl(file, size);
 }
 
-/*
- * vfs_file_test(const gchar * path, GFileTest test)
+/**
+ * vfs_file_test:
+ * @path: A path to test.
+ * @test: A GFileTest to run.
  *
  * Wrapper for g_file_test().
  *
- * Inputs:
- *     - a path to test
- *     - a GFileTest to run
- *
- * Outputs:
- *     - the result of g_file_test().
- *
- * Side Effects:
- *     - g_file_test() is called.
- */
+ * Return value: The result of g_file_test().
+ **/
 gboolean
 vfs_file_test(const gchar * path, GFileTest test)
 {
     return g_file_test(path, test);
 }
 
-/*
- * vfs_is_writable(const gchar * path)
+/**
+ * vfs_is_writable:
+ * @path: A path to test.
  *
  * Tests if a file is writable.
  *
- * Inputs:
- *     - a path to test
- *
- * Outputs:
- *     - FALSE if the file is not writable
- *     - TRUE if the file is writable
- *
- * Side Effects:
- *     - stat() is called.
- *
- * Bugs:
- *     - stat() is not considered part of stdio
- */
+ * Return value: TRUE if the file is writable, otherwise FALSE.
+ **/
 gboolean
 vfs_is_writeable(const gchar * path)
 {