X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=filter_chain.c;h=1a2902477c85d78b2c84739ca5c9d374f5f38a6a;hp=737eaa56580d5f7dbaeafd5a427c34a4288ac391;hb=e9dd157ea38bda80821bd22c34ac49d022a0b3b0;hpb=918232f10ad07b5df9f0884d8ec6b71519e231a4

diff --git a/filter_chain.c b/filter_chain.c
index 737eaa56..1a290247 100644
--- a/filter_chain.c
+++ b/filter_chain.c
@@ -4,7 +4,7 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file filter_chain.c common helper functions for filter input/output */
+/** \file filter_chain.c Common helper functions for filter input/output. */
 
 #include <sys/types.h>
 #include <dirent.h>
@@ -20,9 +20,10 @@
 DEFINE_FILTER_ARRAY(filters);
 
 /**
- * call the init function of each supported filter
+ * Call the init function of each supported filter.
+ *
+ * \param all_filters the array of all supported filters.
  *
- * \param all_filters the array of all supported filters
  * \sa filter::init
  */
 void filter_init(struct filter *all_filters)
@@ -34,9 +35,9 @@ void filter_init(struct filter *all_filters)
 }
 
 /**
- * close and destroy a filter callback
+ * Close and destroy a filter callback.
  *
- * \param fcb the filter callback to close
+ * \param fcb The filter callback to close.
  *
  * This removes \a fcb from the list of filter callbacks and calls
  * the close callback associated with \a fcb.
@@ -49,9 +50,9 @@ static void close_filter_callback(struct filter_callback *fcb)
 }
 
 /**
- * close all callbacks of a filter node
+ * Close all callbacks of a filter node.
  *
- * \param fn the filter node which contains the filter callbacks to be closed
+ * \param fn The filter node which contains the filter callbacks to be closed.
  *
  * Call close_filter_callback() for each entry in the filter callback list
  * of \a fn.
@@ -89,10 +90,10 @@ static void call_callbacks(struct filter_node *fn, char *inbuf, size_t inlen,
 }
 
 /**
- * call the convert function of each filter
+ * Call the convert function of each filter.
  *
- * \param s unused
- * \param t the task containing the filter chain
+ * \param s Unused.
+ * \param t The task identifying the filter chain.
  *
  * This is the core function of the filter subsystem. It loops over the list of
  * filter nodes determined by \a t and calls the filter's convert function if
@@ -103,7 +104,7 @@ static void call_callbacks(struct filter_node *fn, char *inbuf, size_t inlen,
  *
  * On errors a (negative) error code is stored in t->error.
  *
- * \sa filter_node, filter#convert, filter_callback
+ * \sa filter_node, filter#convert, filter_callback.
  */
 void filter_pre_select(__a_unused struct sched *s, struct task *t)
 {
@@ -162,9 +163,9 @@ again:
 }
 
 /**
- * close all filter nodes and its callbacks
+ * Close all filter nodes and their callbacks.
  *
- * \param fc the filter chain to close
+ * \param fc The filter chain to close.
  *
  * For each filter node determined by \a fc, call the close function of each
  * registered filter callback as well as the close function of the
@@ -218,10 +219,10 @@ static int parse_filter_args(int filter_num, char *options, void **conf)
 }
 
 /**
- * check the filter command line options
+ * Check the filter command line options.
  *
- * \param fa the command line options
- * \param conf points to the filter configuration upon successful return
+ * \param fa The command line options.
+ * \param conf Points to the filter configuration upon successful return.
  *
  * Check if \a fa starts with a the name of a supported filter, followed by
  * a colon. If yes, call the command line parser of that filter.