X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=write.h;h=8a60294dccbaef295987041acad36d69fa9f00f0;hp=da6f1e75aabfe2ceac26e9d4c7074e243b9829c9;hb=e65bdaa6b207d5cd409acaa5d0d33fe85dd7a28d;hpb=d56a8447f418cf9046077e743772a416b6f7b826

diff --git a/write.h b/write.h
index da6f1e75..8a60294d 100644
--- a/write.h
+++ b/write.h
@@ -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.
  */
@@ -19,8 +19,11 @@ struct writer_node {
 	void *private_data;
 	/** The writer-specific configuration of this node. */
 	void *conf;
+	/** The buffer tree node associated with this writer node. */
 	struct btr_node *btrn;
+	/** The task of this writer node. */
 	struct task task;
+	/** The minimal input queue size (size of one audio sample). */
 	size_t min_iqs;
 };
 
@@ -50,16 +53,6 @@ struct writer {
 	 * This should free whatever was allocated by \ref parse_config_or_die().
 	 */
 	void (*free_config)(void *config);
-	/**
-	 * Open one instance of this writer.
-	 *
-	 * Perform any preparations needed to write the incoming stream.
-	 * Usually this function just allocates its private data structure and
-	 * stores a pointer to that structure in the ->private data of the
-	 * given parameter. This function must either succeed or terminate the
-	 * process.
-	 */
-	void (*open)(struct writer_node *);
 	/**
 	 * Prepare the fd sets for select.
 	 *
@@ -80,12 +73,19 @@ struct writer {
 	 */
 	void (*close)(struct writer_node *);
 	/**
-	 * Shutdown the writer
+	 * Shutdown the writer.
 	 *
 	 * This is a optional function pointer used for cleaning up.
 	 */
 	void (*shutdown)(struct writer_node *);
+	/** The short and the log help text of this writer. */
 	struct ggo_help help;
+	/**
+	 * The callback handler.
+	 *
+	 * Each writer may provide an ->execute callback which can be used for
+	 * inter-node communication.
+	 */
 	btr_command_handler execute;
 };