From: Andre Noll <maan@systemlinux.org>
Date: Sat, 10 Jul 2010 11:24:36 +0000 (+0200)
Subject: filter.h: Add some missing documentation.
X-Git-Tag: v0.4.4~12
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=2c0737b48ed5a6b269e77a95e4f9bf1bf601f9d9;p=paraslash.git

filter.h: Add some missing documentation.
---

diff --git a/filter.h b/filter.h
index befcd338..c34acca8 100644
--- a/filter.h
+++ b/filter.h
@@ -81,19 +81,38 @@ struct filter {
 	 * argv. On failure, a negative paraslash error code must be returned.
 	 */
 	int (*parse_config)(int argc, char **argv, void **config);
+	/**
+	 * Deallocate the memory for the configuration.
+	 *
+	 * This is called to free whatever ->parse_config() has allocated.
+	 */
 	void (*free_config)(void *conf);
 
 	/** The help texts for this filter. */
 	struct ggo_help help;
+	/**
+	 * 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.
+	 */
 	void (*pre_select)(struct sched *s, struct task *t);
 	/**
 	 * Convert (filter) the given data.
 	 *
-	 * Pointer to the converting function of the filter. It should convert as
-	 * input data as possible. On errors, the post_select function is supposed
-	 * to set t->error to a (negative) error code.
+	 * Pointer to the converting function of the filter. On errors, the
+	 * post_select function is supposed to set t->error to a (negative)
+	 * error code.
 	 */
 	void (*post_select)(struct sched *s, struct task *t);
+	/**
+	 * Answer a buffer tree query.
+	 *
+	 * This optional function pointer is used for inter node communications
+	 * of the buffer tree nodes. See \ref btr_command_handler for details.
+	 */
 	btr_command_handler execute;
 };