paraslash 0.3.1
[paraslash.git] / stdout.c
index 2215f99..a192f2b 100644 (file)
--- a/stdout.c
+++ b/stdout.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 stdout.c functions that deal with writing to stdout */
+/** \file stdout.c Functions that deal with writing to stdout. */
 
 #include <dirent.h> /* readdir() */
 #include <assert.h>
 #include "stdout.h"
 
 /**
- * the pre_select function of the stdout task
+ * The pre_select function of the stdout task.
  *
- * \param s the scheduler this task was registered to
- * \param t the task structure of the stdout task
+ * \param s The scheduler this task was registered to.
+ * \param t The task structure of the stdout task.
  *
  * This function is always successful. If there is data available in the input
  * buffer, it adds \p STDOUT_FILENO to the write fd set of \a s.
@@ -45,10 +45,10 @@ static void stdout_pre_select(struct sched *s, struct task *t)
 }
 
 /**
- * the post select function of the stdout task
+ * The post select function of the stdout task.
  *
- * \param s the scheduler this task was registered to
- * \param t the task structure of the stdout task
+ * \param s The scheduler this task was registered to.
+ * \param t The task structure of the stdout task.
  *
  * This function checks if \p STDOUT_FILENO was included by in the write fd set
  * of \a s during the previous pre_select call.  If yes, and \p STDOUT_FILENO
@@ -85,9 +85,9 @@ static void stdout_default_event_handler(struct task *t)
 }
 
 /**
- * initialize a stdout task structure with default values
+ * Initialize a stdout task structure with default values.
  *
- * \param sot the stdout task structure
+ * \param sot The stdout task structure.
  *
  * This fills in the pre/post select function poinzters of the task structure
  * given by \a sot. It also sets up a default error handler which unregisters