crypt_common.c: Add missing doxygen documentation.

[paraslash.git] / filter_common.c

diff --git a/filter_common.c b/filter_common.c
index 269c4d6d5fb516402d756906bdb57fc5c2be2275..4b1a45de933847267d247660dc8445ea24fe9863 100644 (file)
--- a/filter_common.c
+++ b/filter_common.c
@@ -8,7 +8,6 @@
 
 #include <regex.h>
 #include <sys/types.h>
-#include <dirent.h>
 #include <stdbool.h>
 
 #include "para.h"
@@ -109,6 +108,11 @@ int check_filter_arg(char *fa, void **conf)
        return -E_UNSUPPORTED_FILTER;
 }
 
+/**
+ * Print help text of each filter to stdout.
+ *
+ * \param detailed If non-zero, print detailed help.
+ */
 void print_filter_helps(int detailed)
 {
        int i;
@@ -128,6 +132,17 @@ void print_filter_helps(int detailed)
        }
 }
 
+/**
+ * Set select timeout of the the scheduler.
+ *
+ * \param s The scheduler.
+ * \param t The task struct of this filter.
+ *
+ * This looks at the status of the btr node of the filter. If data is available
+ * in the input queue of the filter, or if an error occured, a minimal timeout
+ * for the next select call is requested from the scheduler. Otherwise the
+ * scheduler timeout is left unchanged.
+ */
 void generic_filter_pre_select(struct sched *s, struct task *t)
 {
        struct filter_node *fn = container_of(t, struct filter_node, task);