Makefile.in: Add ao_write.ggo to ggos.

[paraslash.git] / write.h

diff --git a/write.h b/write.h
index d5834b4c436eafae77cb7a086c045c4bf6f0a81b..8a60294dccbaef295987041acad36d69fa9f00f0 100644 (file)
--- 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;
 };
 
@@ -70,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;
 };