fix trivial typo

[paraslash.git] / stdout.h

diff --git a/stdout.h b/stdout.h
index e467f41d03299c4350997e5320547ff2b02ba760..0d2ab2afb5672dc2969b2b8815cd83e1376bbfec 100644 (file)
--- a/stdout.h
+++ b/stdout.h
@@ -1,9 +1,26 @@
+/*
+ * Copyright (C) 2006-2007 Andre Noll <maan@systemlinux.org>
+ *
+ * Licensed under the GPL v2. For licencing details see COPYING.
+ */
+
+/** \file stdout.h the stdout task structure and exported symbols from stdout.c */
+
+/**
+ * the task structure used for writing to stdout
+ */
 struct stdout_task {
+       /** pointer to the data buffer */
        char *buf;
-       size_t *bufsize;
+       /** number of bytes loaded in \a buf */
        size_t *loaded;
-       int *eof;
+       /** pointer to the eof flag of the feeding task */
+       int *input_eof;
+       /** non-zero if a write error occured */
+       int eof;
+       /** the task structure */
        struct task task;
+       /** whether \p STDOUT_FILENO was included in the write fd set */
        int check_fd;
 };