filter.h: Improve documentation of ->pre_select().
[paraslash.git] / filter.h
index 135a688..7ae28fe 100644 (file)
--- a/filter.h
+++ b/filter.h
@@ -96,10 +96,12 @@ struct filter {
        /**
         * Set scheduler timeout and add file descriptors to fd sets.
         *
-        * This function is used to control the timeout value for select. It
-        * only allowed to decrease the current value. The second purpose of
-        * this function is to set file descriptors to be watched by the
-        * subsequent select call to the two fd sets.
+        * This function controls the timeout value for the next call to
+        * select(2). It may decrease the current timeout but shall never
+        * increase it. The second purpose of this function is to add file
+        * descriptors to the two fd sets of the sched structure. The
+        * descriptors in these sets will be watched by the subsequent
+        * select(2) call.
         */
        void (*pre_select)(struct sched *s, void *context);
        /**