Fix documentation of select command.

[paraslash.git] / stdin.c

diff --git a/stdin.c b/stdin.c
index afbe35f8eaf2f74a7e04437e5c60de1a2a6a9b1b..4e567008dd1f2f7a3d98cf691a6ce04c2e5a7de1 100644 (file)
--- a/stdin.c
+++ b/stdin.c
@@ -1,10 +1,10 @@
 /*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2008 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file stdin.c functions that deal with reading from stdin */
+/** \file stdin.c Functions that deal with reading from stdin. */
 
 #include <dirent.h> /* readdir() */
 #include <assert.h>
@@ -19,10 +19,10 @@
 #include "stdin.h"
 
 /**
- * the pre_select function of the stdin task
+ * The pre_select function of the stdin task.
  *
- * \param s the scheduler this task was registered to
- * \param t the task structure of the stdin task
+ * \param s The scheduler this task was registered to.
+ * \param t The task structure of the stdin task.
  *
  * This function is always successful. If there is space left in the
  * buffer of the stdin task, it adds \p STDIN_FILENO to the read fd set
@@ -46,10 +46,10 @@ static void stdin_default_event_handler(struct task *t)
 }
 
 /**
- * the post select function of the stdin task
+ * The post select function of the stdin task.
  *
- * \param s the scheduler this task was registered to
- * \param t the task structure of the stdin task
+ * \param s The scheduler this task was registered to.
+ * \param t The task structure of the stdin task.
  *
  * This function checks if \p STDIN_FILENO was included by in the read fd set
  * of \a s during the previous pre_select call.  If yes, and \p STDIN_FILENO