/*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2007 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 */
+/** \file stdin.h The standard in task structure. */
-/**
- * the task structure used for reading from stdin
- */
+/** The task structure used for reading from stdin. */
struct stdin_task {
- /** input buffer */
+ /** Input buffer. */
char *buf;
- /** the size of \a buf */
+ /** The size of \a buf. */
size_t bufsize;
- /** number of bytes currently loaded in \a buf */
+ /** Number of bytes currently loaded in \a buf. */
size_t loaded;
- /** whether \p STDIN_FILENO was included in the read fd set */
+ /** Whether \p STDIN_FILENO was included in the read fd set. */
int check_fd;
- /** the task structure */
+ /** The task structure. */
struct task task;
- /** non-zero on read error, or if a read from stdin returned zero */
+ /** Non-zero on read error, or if a read from stdin returned zero. */
int eof;
};