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

[paraslash.git] / stdout.h

diff --git a/stdout.h b/stdout.h
index 0d2ab2afb5672dc2969b2b8815cd83e1376bbfec..1e35d6ca14238a7cee97bdd91889c1f2b186f654 100644 (file)
--- a/stdout.h
+++ b/stdout.h
@@ -1,29 +1,21 @@
 /*
 /*

- * Copyright (C) 2006-2007 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 stdout task structure and exported symbols from stdout.c */
+/** \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 */
-       char *buf;
-       /** number of bytes loaded in \a buf */
-       size_t *loaded;
-       /** pointer to the eof flag of the feeding task */
-       int *input_eof;
-       /** non-zero if a write error occured */
-       int eof;
-       /** 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;
+       /** Stdout is always a leaf node in the buffer tree. */
+       struct btr_node *btrn;

 };
 
 };
 

-void stdout_pre_select(struct sched *s, struct task *t);
-void stdout_post_select(struct sched *s, struct task *t);

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