Doxify error2.c and add GPL header.

[paraslash.git] / sched.h

diff --git a/sched.h b/sched.h
index 7a5a4f867b41fd1e661da8cf4b11032d8506fddc..234a8458d5870a1f14c66c81c140b61c0c20bf01 100644 (file)
--- a/sched.h
+++ b/sched.h
@@ -41,10 +41,7 @@ struct sched {
  * Before registering a task to the scheduler, the task structure must be
  * filled in properly by the caller.
  *
- * If one of these functions sets \a t->error to a negative value, the
- * task gets unregistered automatically.
- *
- * \sa struct sched.
+ * \sa \ref sched.
  */
 struct task {
        /**
@@ -55,11 +52,13 @@ struct task {
         */
        void (*pre_select)(struct sched *s, struct task *t);
        /**
-        * The postselect hook of \a t.
+        * The post select hook of \a t.
         *
-        * Evaluate and act upon the results of the previous select call.
+        * Its purpose is to evaluate and act upon the results of the previous
+        * select call. If this function returns a negative value, the
+        * scheduler unregisters the task.
         */
-       void (*post_select)(struct sched *s, struct task *t);
+       int (*post_select)(struct sched *s, struct task *t);
        /** Whether this task is in error state. */
        int error;
        /** Position of the task in the pre_select list of the scheduler. */
@@ -76,7 +75,7 @@ struct task {
  * This is set by the scheduler at the beginning of its main loop.  It may be
  * used (read-only) from everywhere. As none of the functions called by the
  * scheduler are allowed to block, this value should be accurate enough so that
- * there is no need to call gettimeofday() directly.
+ * there is no need to call clock_gettime() directly.
  */
 extern struct timeval *now;