command_util: Generate properly documented command header files.

[paraslash.git] / stdout.h

diff --git a/stdout.h b/stdout.h
index 5e45ace8dc20fc88e30d2305ee73b438fe65471e..cca12e5f61e2538d99c766f350ee4ef002bce801 100644 (file)
--- a/stdout.h
+++ b/stdout.h
@@ -1,13 +1,25 @@
+/*
+ * Copyright (C) 2006-2009 Andre Noll <maan@systemlinux.org>
+ *
+ * Licensed under the GPL v2. For licencing details see COPYING.
+ */
+
+/** \file stdout.h The standard out task structure. */
+
+/**
+ * The task structure used for writing to stdout.
+ */
 struct stdout_task {
-       char *buf;
-       size_t *bufsize;
+       /** Pointer to the data buffer pointer. */
+       char **bufp;
+       /** Number of bytes loaded in \a buf. */
        size_t *loaded;
-       int *input_eof;
-       int eof;
+       /** Pointer to the error variable of the feeding task. */
+       int *input_error;
+       /** The task structure. */
        struct task task;
+       /** Whether \p STDOUT_FILENO was included in the write fd set. */
        int check_fd;
 };
 
-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);