From: Andre <maan@p133.(none)>
Date: Tue, 13 Jun 2006 01:11:14 +0000 (+0200)
Subject: doxify stdin.h
X-Git-Tag: v0.2.14~62^2~14
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=fbcc28c36aa7d5e07874e473cbaf044124afd63b;p=paraslash.git

doxify stdin.h
---

diff --git a/stdin.h b/stdin.h
index cb6cbfb6..b9ee68be 100644
--- a/stdin.h
+++ b/stdin.h
@@ -1,8 +1,36 @@
+/*
+ * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ *
+ *     This program is free software; you can redistribute it and/or modify
+ *     it under the terms of the GNU General Public License as published by
+ *     the Free Software Foundation; either version 2 of the License, or
+ *     (at your option) any later version.
+ *
+ *     This program is distributed in the hope that it will be useful,
+ *     but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *     GNU General Public License for more details.
+ *
+ *     You should have received a copy of the GNU General Public License
+ *     along with this program; if not, write to the Free Software
+ *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ */
+
+/** \file stdin.h the stdin task structure and exported symbols from stdin.c */
+
+/**
+ * the task structure used when 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;
+	/** the task structure */
 	struct task task;
+	/** non-zero if a read from stdin returned zero */
 	int eof;
 };