changeset 2059:8aaf0f145578 trunk

[svn] - documentation fixups

--- a/ChangeLog	Mon Dec 04 18:21:39 2006 -0800
+++ b/ChangeLog	Mon Dec 04 18:30:58 2006 -0800
@@ -1,3 +1,12 @@
[phone]:21:39 +0000  William Pitcock <[e-mail]>
+  revision [3119]
+  - a directory browser widget
+  
+  trunk/doc/libaudacious/tmpl/dirbrowser.sgml |   31 ++++++++++++++++++++++++++++
+  trunk/libaudacious/dirbrowser.c             |   11 +++++++++
+  2 files changed, 42 insertions(+)
+
+
 2006-12-05 02:08:15 +0000  William Pitcock <[e-mail]>
   revision [3117]
   - document rcfile

--- a/libaudacious/titlestring.h	Mon Dec 04 18:21:39 2006 -0800
+++ b/libaudacious/titlestring.h	Mon Dec 04 18:30:58 2006 -0800
@@ -78,7 +78,7 @@
 void bmp_title_input_free(BmpTitleInput * input);
 
 gchar *xmms_get_titlestring(const gchar * fmt, TitleInput * input);
-GtkWidget *xmms_titlestring_descriptions(gchar * tags, gint rows);
+GtkWidget *xmms_titlestring_descriptions(gchar * tags, gint columns);
 
 G_END_DECLS
 

--- a/libaudacious/vfs.c	Mon Dec 04 18:21:39 2006 -0800
+++ b/libaudacious/vfs.c	Mon Dec 04 18:30:58 2006 -0800
@@ -259,7 +259,7 @@
 }
 
 /**
- * vfs_fseek:
+ * vfs_ftell:
  * @file: #VFSFile object that represents the VFS stream.
  *
  * Returns the current position in the VFS stream's buffer.
@@ -295,19 +295,19 @@
 /**
  * vfs_truncate:
  * @file: #VFSFile object that represents the VFS stream.
- * @size: The length to truncate at.
+ * @length: The length to truncate at.
  *
  * Truncates a VFS stream to a certain size.
  *
  * Return value: On success, 0. Otherwise, -1.
  **/
 gint
-vfs_truncate(VFSFile * file, glong size)
+vfs_truncate(VFSFile * file, glong length)
 {
     if (file == NULL)
         return -1;
 
-    return file->base->vfs_truncate_impl(file, size);
+    return file->base->vfs_truncate_impl(file, length);
 }
 
 /**
@@ -326,12 +326,12 @@
 }
 
 /**
- * vfs_is_writable:
+ * vfs_is_writeable:
  * @path: A path to test.
  *
- * Tests if a file is writable.
+ * Tests if a file is writeable.
  *
- * Return value: TRUE if the file is writable, otherwise FALSE.
+ * Return value: TRUE if the file is writeable, otherwise FALSE.
  **/
 gboolean
 vfs_is_writeable(const gchar * path)

--- a/libaudacious/vfs_common.c	Mon Dec 04 18:21:39 2006 -0800
+++ b/libaudacious/vfs_common.c	Mon Dec 04 18:30:58 2006 -0800
@@ -18,7 +18,15 @@
 #include <stdlib.h>
 #include <glib/gprintf.h>
 
-
+/**
+ * vfs_fputc:
+ * @c: A character to write to the stream.
+ * @stream: A #VFSFile object representing the stream.
+ *
+ * Writes a character to a stream.
+ *
+ * Return value: The character on success, or EOF.
+ **/
 gint vfs_fputc(gint c, VFSFile *stream)
 {
     guchar uc = (guchar) c;
@@ -30,6 +38,16 @@
     return uc;
 }
 
+/**
+ * vfs_fgets:
+ * @s: A buffer to put the string in.
+ * @n: The amount of characters to read.
+ * @stream: A #VFSFile object representing the stream.
+ *
+ * Reads a set of characters from a stream.
+ *
+ * Return value: The string on success, or NULL.
+ **/
 gchar *vfs_fgets(gchar *s, gint n, VFSFile *stream)
 {
     gint c;
@@ -55,6 +73,15 @@
     return NULL;
 }
 
+/**
+ * vfs_fputc:
+ * @s: A string to write to the stream.
+ * @stream: A #VFSFile object representing the stream.
+ *
+ * Writes a string to a VFS stream.
+ *
+ * Return value: The amount of bytes written.
+ **/
 int vfs_fputs(const gchar *s, VFSFile *stream)
 {
 	size_t n = strlen(s);
@@ -62,6 +89,16 @@
 	return ((vfs_fwrite(s, 1, n, stream) == n) ? n : EOF);
 }
 
+/**
+ * vfs_vfprintf:
+ * @stream: A #VFSFile object representing the stream.
+ * @format: A printf-style format string.
+ * @args: A va_list of args to use.
+ *
+ * Writes a formatted string to a VFS stream via a va_list of args.
+ *
+ * Return value: The amount of bytes written.
+ **/
 int vfs_vfprintf(VFSFile *stream, gchar const *format, va_list args)
 {
     gchar *string;
@@ -72,6 +109,15 @@
     return rv;
 }
 
+/**
+ * vfs_fprintf:
+ * @stream: A #VFSFile object representing the stream.
+ * @format: A printf-style format string.
+ *
+ * Writes a formatted string to a VFS stream.
+ *
+ * Return value: The amount of bytes written.
+ **/
 int vfs_fprintf(VFSFile *stream, gchar const *format, ...)
 {
     va_list arg;