stdin.h: Add missing doxygen comment for stdin_task->btrp.

[paraslash.git] / stdout.h

diff --git a/stdout.h b/stdout.h
index c3eb311..1e35d6c 100644 (file)
--- a/stdout.h
+++ b/stdout.h
@@ -1,27 +1,21 @@
 /*
 /*

- * Copyright (C) 2006-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2011 Andre Noll <maan@systemlinux.org>

  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 

-/** \file stdout.h The standard out task structure. */
+/** \file stdout.h Writing to stdout via buffer trees. */

 
 /**
  * The task structure used for writing to stdout.
 
 /**
  * The task structure used for writing to stdout.

+ *
+ * This is used by para_recv, para_filter and para_client.

  */
 struct stdout_task {
  */
 struct stdout_task {

-       /** Pointer to the data buffer pointer. */
-       char **bufp;
-       /** Number of bytes loaded in \a buf. */
-       size_t *loaded;
-       /** Pointer to the error variable of the feeding task. */
-       int *input_error;
-       /** The task structure. */
+       /** The task structure used by the scheduler. */

        struct task task;
        struct task task;

-       /** Whether \p STDOUT_FILENO was included in the write fd set. */
-       int check_fd;
-       /** Whether to use the buffer tree API. */
-       bool use_buffer_tree;
+       /** Stdout is always a leaf node in the buffer tree. */
+       struct btr_node *btrn;

 };
 
 void stdout_set_defaults(struct stdout_task *sot);
 };
 
 void stdout_set_defaults(struct stdout_task *sot);