X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=stdin.h;h=4f5a6112feb8ded051560f95acc04ec03432fd29;hp=6931f330f440ca9005fadbbc93e11178bd9bee02;hb=51cab2aba416fc1d57336f4e72da6b76ec60174c;hpb=f8b73704e27c5b5fad77cfddd06951dabcc6bf56 diff --git a/stdin.h b/stdin.h index 6931f330..4f5a6112 100644 --- a/stdin.h +++ b/stdin.h @@ -1,26 +1,24 @@ /* - * Copyright (C) 2006 Andre Noll + * Copyright (C) 2006-2007 Andre Noll * * 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; };