sched.c: Cosmetic cleanups.
authorAndre Noll <maan@systemlinux.org>
Mon, 31 Mar 2008 11:56:15 +0000 (13:56 +0200)
committerAndre Noll <maan@systemlinux.org>
Mon, 31 Mar 2008 11:56:15 +0000 (13:56 +0200)
sched.c

diff --git a/sched.c b/sched.c
index 869c94c..5d4901d 100644 (file)
--- a/sched.c
+++ b/sched.c
@@ -4,7 +4,7 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file sched.c paraslash's scheduling functions */
+/** \file sched.c Paraslash's scheduling functions. */
 
 #include <dirent.h> /* readdir() */
 #include <assert.h>
@@ -27,7 +27,7 @@ struct timeval *now = &now_struct;
 /**
  * Remove a task from the scheduler.
  *
- * \param t the task to remove
+ * \param t The task to remove.
  *
  * If the pre_select pointer of \a t is not \p NULL, it is removed from
  * the pre_select list of the scheduler. Same goes for \a post_select.
@@ -83,9 +83,9 @@ static void sched_post_select(struct sched *s)
 }
 
 /**
- * the core function for all paraslash programs
+ * The core function for all paraslash programs.
  *
- * \param s pointer to the scheduler struct
+ * \param s Pointer to the scheduler struct.
  *
  * This function updates the global \a now pointer, calls all registered
  * pre_select hooks which may set the timeout and add any file descriptors to
@@ -123,7 +123,7 @@ again:
 }
 
 /**
- * initialize the paraslash scheduler
+ * Initialize the paraslash scheduler.
  */
 static void init_sched(void)
 {
@@ -134,7 +134,7 @@ static void init_sched(void)
 };
 
 /**
- * add a task to the scheduler
+ * Add a task to the scheduler.
  *
  * \param t the task to add
  *
@@ -159,7 +159,7 @@ void register_task(struct task *t)
 }
 
 /**
- * unregister all tasks
+ * Unregister all tasks.
  *
  * This will cause \a schedule() to return immediately because both the
  * \a pre_select_list and the \a post_select_list are empty.
@@ -179,9 +179,9 @@ void sched_shutdown(void)
 };
 
 /**
- * get the list of all registered tasks.
+ * Get the list of all registered tasks.
  *
- * \return the task list
+ * \return The task list.
  *
  * Each entry of the list contains an identifier which is simply a hex number
  * that may be used in \a kill_task() to terminate the task.
@@ -213,9 +213,9 @@ char *get_task_list(void)
 }
 
 /**
- * simulate an error for the given task
+ * Simulate an error for the given task.
  *
- * \param id the task identifier
+ * \param id The task identifier.
  *
  * Find the task identified by \a id, set the tasks' error value to
  * \p -E_TASK_KILLED and unregister the task.