Mercurial > audlegacy
changeset 2050:e6b15b72feac trunk
[svn] - document the tuple system
| author | nenolod |
|---|---|
| date | Mon, 04 Dec 2006 02:05:30 -0800 |
| parents | 5cf8de9f2c28 |
| children | 27aa778eb73c |
| files | ChangeLog doc/libaudacious/tmpl/titlestring.sgml libaudacious/titlestring.c |
| diffstat | 3 files changed, 41 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/ChangeLog Mon Dec 04 01:56:48 2006 -0800 +++ b/ChangeLog Mon Dec 04 02:05:30 2006 -0800 @@ -1,3 +1,13 @@ +2006-12-04 09:56:48 +0000 William Pitcock <nenolod@nenolod.net> + revision [3101] + - document ConfigDB. + + trunk/doc/libaudacious/tmpl/configdb.sgml | 4 + trunk/doc/libaudacious/tmpl/libaudacious-unused.sgml | 24 +++ + trunk/libaudacious/configdb.h | 130 +++++++++++++++++++ + 3 files changed, 156 insertions(+), 2 deletions(-) + + 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
--- a/doc/libaudacious/tmpl/titlestring.sgml Mon Dec 04 01:56:48 2006 -0800 +++ b/doc/libaudacious/tmpl/titlestring.sgml Mon Dec 04 02:05:30 2006 -0800 @@ -1,8 +1,8 @@ <!-- ##### SECTION Title ##### --> -titlestring +Tuples and Title Formatting <!-- ##### SECTION Short_Description ##### --> - +Generating tuples and titles from them. <!-- ##### SECTION Long_Description ##### --> <para>
--- a/libaudacious/titlestring.c Mon Dec 04 01:56:48 2006 -0800 +++ b/libaudacious/titlestring.c Mon Dec 04 02:05:30 2006 -0800 @@ -39,7 +39,11 @@ #define VS(input, field) (CHECK(input, field) ? input->field : NULL) #define VI(input, field) (CHECK(input, field) ? input->field : 0) - +/** + * bmp_title_input_new: + * + * #BmpTitleInput tuple factory. + **/ BmpTitleInput * bmp_title_input_new() { @@ -50,6 +54,12 @@ return input; } +/** + * bmp_title_input_free: + * @input: A #BmpTitleInput tuple to destroy. + * + * Destroys a #BmpTitleInput tuple. + **/ void bmp_title_input_free(BmpTitleInput * input) { @@ -83,6 +93,15 @@ g_free(input); } +/** + * xmms_get_titlestring: + * @fmt: A format string. + * @input: A tuple to use for data. + * + * Generates a formatted string from a tuple. + * + * Return value: A formatted tuple string. + **/ gchar * xmms_get_titlestring(const gchar * fmt, TitleInput * input) { @@ -363,6 +382,15 @@ gint tag_descriptions_length = sizeof(tag_descriptions) / sizeof(TagDescription); +/** + * xmms_titlestring_descriptions: + * @tags: A list of formatters to provide. + * @columns: A number of columns to arrange them in. + * + * Generates a box explaining how to use the formatters. + * + * Return value: A GtkWidget containing the table. + **/ GtkWidget * xmms_titlestring_descriptions(gchar * tags, gint columns) {