Mercurial > audlegacy

changeset 2049:5cf8de9f2c28 trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[svn] - document ConfigDB.
author nenolod
date Mon, 04 Dec 2006 01:56:48 -0800
parents 7bc2489db782
children e6b15b72feac
files ChangeLog doc/libaudacious/tmpl/configdb.sgml doc/libaudacious/tmpl/libaudacious-unused.sgml libaudacious/configdb.h
diffstat 4 files changed, 163 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog	Mon Dec 04 01:46:09 2006 -0800
+++ b/ChangeLog	Mon Dec 04 01:56:48 2006 -0800
@@ -1,3 +1,10 @@
+2006-12-04 09:46:09 +0000  Daniel Bradshaw <nazca@atheme.org>
+  revision [3099]
+  Numpad 4 and 6 liked to prev and next respectively to be more consistant with the main window
+  trunk/audacious/ui_playlist.c |    6 ++++++
+  1 file changed, 6 insertions(+)
+
+
 2006-12-04 09:44:20 +0000  William Pitcock <nenolod@nenolod.net>
   revision [3097]
   - remove xml_document.c
--- a/doc/libaudacious/tmpl/configdb.sgml	Mon Dec 04 01:46:09 2006 -0800
+++ b/doc/libaudacious/tmpl/configdb.sgml	Mon Dec 04 01:56:48 2006 -0800
@@ -1,8 +1,8 @@
 <!-- ##### SECTION Title ##### -->
-configdb
+ConfigDB
 
 <!-- ##### SECTION Short_Description ##### -->
-
+The audacious configuration database.
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
--- a/doc/libaudacious/tmpl/libaudacious-unused.sgml	Mon Dec 04 01:46:09 2006 -0800
+++ b/doc/libaudacious/tmpl/libaudacious-unused.sgml	Mon Dec 04 01:56:48 2006 -0800
@@ -1,3 +1,27 @@
+<!-- ##### SECTION ./tmpl/xml_document.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/xml_document.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/xml_document.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/xml_document.sgml:Stability_Level ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/xml_document.sgml:Title ##### -->
+xml_document
+
+
 <!-- ##### STRUCT XmmsEntry ##### -->
 <para>
 
--- a/libaudacious/configdb.h	Mon Dec 04 01:46:09 2006 -0800
+++ b/libaudacious/configdb.h	Mon Dec 04 01:56:48 2006 -0800
@@ -9,51 +9,181 @@
 
 G_BEGIN_DECLS
 
+    /**
+     * bmp_cfg_db_open:
+     *
+     * Opens the configuration database.
+     *
+     * Return value: A configuration database handle.
+     **/
     ConfigDb *bmp_cfg_db_open();
+
+    /**
+     * bmp_cfg_db_close:
+     * @db: A configuration database handle.
+     *
+     * Closes the configuration database.
+     **/
     void bmp_cfg_db_close(ConfigDb *db);
 
+    /**
+     * bmp_cfg_db_get_string:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to look up.
+     * @value: Pointer to a buffer to put the data in.
+     *
+     * Searches the configuration database for a value.
+     *
+     * Return value: TRUE if successful, FALSE otherwise.
+     **/
     gboolean bmp_cfg_db_get_string(ConfigDb *db,
                                    const gchar *section,
                                    const gchar *key,
                                    gchar **value);
+
+    /**
+     * bmp_cfg_db_get_int:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to look up.
+     * @value: Pointer to an integer to put the data in.
+     *
+     * Searches the configuration database for a value.
+     *
+     * Return value: TRUE if successful, FALSE otherwise.
+     **/
     gboolean bmp_cfg_db_get_int(ConfigDb *db,
                                 const gchar *section,
                                 const gchar *key,
                                 gint *value);
+
+    /**
+     * bmp_cfg_db_get_bool:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to look up.
+     * @value: Pointer to a boolean to put the data in.
+     *
+     * Searches the configuration database for a value.
+     *
+     * Return value: TRUE if successful, FALSE otherwise.
+     **/
     gboolean bmp_cfg_db_get_bool(ConfigDb *db,
                                  const gchar *section,
                                  const gchar *key,
                                  gboolean *value);
+
+    /**
+     * bmp_cfg_db_get_float:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to look up.
+     * @value: Pointer to a floating point integer to put the data in.
+     *
+     * Searches the configuration database for a value.
+     *
+     * Return value: TRUE if successful, FALSE otherwise.
+     **/
     gboolean bmp_cfg_db_get_float(ConfigDb *db,
                                   const gchar *section,
                                   const gchar *key,
                                   gfloat *value);
+
+    /**
+     * bmp_cfg_db_get_double:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to look up.
+     * @value: Pointer to a double-precision floating point integer to put the data in.
+     *
+     * Searches the configuration database for a value.
+     *
+     * Return value: TRUE if successful, FALSE otherwise.
+     **/
     gboolean bmp_cfg_db_get_double(ConfigDb *db,
                                    const gchar *section,
                                    const gchar *key,
                                    gdouble *value);
 
+    /**
+     * bmp_cfg_db_set_string:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to set.
+     * @value: Pointer to a buffer containing the data.
+     *
+     * Sets a value in the configuration database.
+     **/
     void bmp_cfg_db_set_string(ConfigDb *db,
                                const gchar *section,
                                const gchar *key,
                                gchar *value);
+
+    /**
+     * bmp_cfg_db_set_int:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to set.
+     * @value: Pointer to an integer containing the data.
+     *
+     * Sets a value in the configuration database.
+     **/
     void bmp_cfg_db_set_int(ConfigDb *db,
                             const gchar *section,
                             const gchar *key,
                             gint value);
+
+    /**
+     * bmp_cfg_db_set_bool:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to set.
+     * @value: Pointer to a boolean containing the data.
+     *
+     * Sets a value in the configuration database.
+     **/
     void bmp_cfg_db_set_bool(ConfigDb *db,
                              const gchar *section,
                              const gchar *key,
                              gboolean value);
+
+    /**
+     * bmp_cfg_db_set_float:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to set.
+     * @value: Pointer to a floating point integer containing the data.
+     *
+     * Sets a value in the configuration database.
+     **/
     void bmp_cfg_db_set_float(ConfigDb *db,
                               const gchar *section,
                               const gchar *key,
                               gfloat value);
+
+    /**
+     * bmp_cfg_db_set_double:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to set.
+     * @value: Pointer to a double precision floating point integer containing the data.
+     *
+     * Sets a value in the configuration database.
+     **/
     void bmp_cfg_db_set_double(ConfigDb *db,
                                const gchar *section,
                                const gchar *key,
                                gdouble value);
 
+    /**
+     * bmp_cfg_db_unset_key:
+     * @db: A configuration database handle.
+     * @section: The section of the configuration database to search.
+     * @key: The name of the field in the configuration database to set.
+     *
+     * Removes a value from the configuration database.
+     **/
     void bmp_cfg_db_unset_key(ConfigDb *db,
                               const gchar *section,
                               const gchar *key);