rc4: Round up output buffer size.
[paraslash.git] / stdout.h
index 4dafafd..0d2ab2a 100644 (file)
--- a/stdout.h
+++ b/stdout.h
@@ -1,11 +1,26 @@
-/** \file stdout.h common code for uitlities that write to stdout */
+/*
+ * 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;
+       /** 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;
 };