complete documentation of stdin.* and stdout.*

[paraslash.git] / stdin.h

diff --git a/stdin.h b/stdin.h
index b9ee68be23004924e3002421214319eebba35dec..a36b98879fd5c6c17b10140dda4ea64175d88964 100644 (file)
--- a/stdin.h
+++ b/stdin.h
@@ -19,7 +19,7 @@
 /** \file stdin.h the stdin task structure and exported symbols from stdin.c */
 
 /**
- * the task structure used when reading from stdin
+ * the task structure used for reading from stdin
  */
 struct stdin_task {
        /** input buffer */
@@ -28,9 +28,11 @@ struct stdin_task {
        size_t bufsize;
        /** number of bytes currently loaded in \a buf */
        size_t loaded;
+       /** whether STDIN_FILENO was included in the read fd set */
+       int check_fd;
        /** the task structure */
        struct task task;
-       /** non-zero if a read from stdin returned zero */
+       /** non-zero on read error, or if a read from stdin returned zero */
        int eof;
 };