* 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>
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)
}
/**
- * 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.
}
/**
- * 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.
}
/**
- * 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
*
* 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)
{
}
/**
- * 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
}
/**
- * 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.