X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=stdin.h;h=e1295927b14ae9988be21b673e940147e0255307;hp=cb6cbfb6b3797f0f954d99d2c39e8369663be0aa;hb=434b32087a9e2d54ca88072ca798a703a2ff629f;hpb=40cbbb95e256e63e1e6958e9034311d4904604af

diff --git a/stdin.h b/stdin.h
index cb6cbfb6..e1295927 100644
--- a/stdin.h
+++ b/stdin.h
@@ -1,8 +1,26 @@
+/*
+ * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ *
+ * Licensed under the GPL v2. For licencing details see COPYING.
+ */
+
+/** \file stdin.h the stdin task structure and exported symbols from stdin.c */
+
+/**
+ * the task structure used for reading from stdin
+ */
 struct stdin_task {
+	/** input buffer */
 	char *buf;
+	/** the size of \a buf */
 	size_t bufsize;
+	/** number of bytes currently loaded in \a buf */
 	size_t loaded;
+	/** whether \p STDIN_FILENO was included in the read fd set */
+	int check_fd;
+	/** the task structure */
 	struct task task;
+	/** non-zero on read error, or if a read from stdin returned zero */
 	int eof;
 };