trivial doxygen cleanups

[paraslash.git] / stdin.h

diff --git a/stdin.h b/stdin.h
index 9213bf4623dbe0179b53ca81dd125f1d2a4ed197..e1295927b14ae9988be21b673e940147e0255307 100644 (file)
--- a/stdin.h
+++ b/stdin.h
@@ -1,9 +1,29 @@
+/*
+ * 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 {
 struct stdin_task {

+       /** input buffer */

        char *buf;
        char *buf;

+       /** the size of \a buf */

        size_t bufsize;
        size_t bufsize;

+       /** number of bytes currently loaded in \a buf */

        size_t loaded;
        size_t loaded;

+       /** whether \p STDIN_FILENO was included in the read fd set */
+       int check_fd;
+       /** the task structure */

        struct task task;
        struct task task;

+       /** non-zero on read error, or if a read from stdin returned zero */
+       int eof;

 };
 
 void stdin_pre_select(struct sched *s, struct task *t);
 void stdin_post_select(struct sched *s, struct task *t);
 };
 
 void stdin_pre_select(struct sched *s, struct task *t);
 void stdin_post_select(struct sched *s, struct task *t);

+void stdin_set_defaults(struct stdin_task *sit);