X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=write_common.c;h=faf20749ba33062ed66845cafa38a283bcaa3c02;hp=04db8ff0d1e0da00207930e682fddc84678e88d2;hb=e9ac00becb2aba5bbbf51b4803b81b10ed4d6788;hpb=b5b5d00eea33eccd3d2d75057c5254bf85568b00

diff --git a/write_common.c b/write_common.c
index 04db8ff0..faf20749 100644
--- a/write_common.c
+++ b/write_common.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006-2010 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2011 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -35,10 +35,10 @@ void writer_init(void)
 		writers[i].init(&writers[i]);
 }
 /**
- * check if given string is a valid command line for any writer
+ * Check if given string is a valid command line for any writer.
  *
- * \param \wa string of the form writer_name:options
- * \param writer_num contains the number of the writer upon success
+ * \param \wa String of the form writer_name:options.
+ * \param writer_num Contains the number of the writer upon success.
  *
  * This function checks whether \a wa starts with the name of a supported
  * paraslash writer, optionally followed by a colon and any options for that
@@ -98,20 +98,24 @@ void register_writer_node(struct writer_node *wn, struct btr_node *parent)
 }
 
 /**
- * Setup a writer node with the default writer.
+ * Parse config and register a task for a writer node.
  *
- * If arg is \p NULL, the OS-dependent default writer is used with an empty
- * configuration string.  It defaults to alsa for Linux, osx for OS X, oss for
- * *BSD and the file writer if neither of these is supported.
+ * \param arg Command line arguments.
+ * \param parent The new node will be a child of \a parent.
+ * \param wn The writer node.
  *
- * Once the writer configuration has been retrieved, a writer node is created,
- * its buffer tree node is added to the buffer tree as a child of the given
- * parent.
+ * If arg is \p NULL, the OS-dependent default writer is used with no
+ * arguments.  The default writers are alsa for Linux, osx for OS X, oss for
+ * *BSD, and the file writer if the default writer is not supported.
  *
- * Finally, the new writer node's taks structure is initialized and registered
+ * Once the writer configuration has been retrieved from the ->parse_config
+ * callback a writer node is created, its buffer tree node is added to the
+ * buffer tree as a child of the given parent.
+ *
+ * Finally, the new writer node's task structure is initialized and registered
  * to the paraslash scheduler.
  *
- * \return A pointer to the allocated writer node group.
+ * \return Standard.
  */
 int setup_writer_node(const char *arg, struct btr_node *parent,
 		struct writer_node *wn)