X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=stdout.h;h=0d2ab2afb5672dc2969b2b8815cd83e1376bbfec;hp=4dafafdec596d3ff60fd70dbc2291482165f71d0;hb=e5a4d6bb1e2ca7f81bc99b5d543cd5a0e5ffc693;hpb=4b6458e9fc11eb741200dfebd8dc96a333956e4b

diff --git a/stdout.h b/stdout.h
index 4dafafde..0d2ab2af 100644
--- 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;
 };