doxify para_filter
authorAndre <maan@p133.(none)>
Fri, 5 Jan 2007 18:05:45 +0000 (19:05 +0100)
committerAndre <maan@p133.(none)>
Fri, 5 Jan 2007 18:05:45 +0000 (19:05 +0100)
Doxyfile
filter.c

index ba35867..1266179 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -487,7 +487,7 @@ EXCLUDE_SYMLINKS       = NO
 # against the file with absolute path, so to exclude all test directories 
 # for example use the pattern */test/*
 
-EXCLUDE_PATTERNS = list.h *.cmdline.* krell.* gui* SFont* gcc-compat.h rc4.h recv.c para.h fade.c config.h sdl_gui.c filter.c slider.c dbadm.c
+EXCLUDE_PATTERNS = list.h *.cmdline.* krell.* gui* SFont* gcc-compat.h rc4.h recv.c para.h fade.c config.h sdl_gui.c slider.c dbadm.c
 
 # The EXAMPLE_PATH tag can be used to specify one or more files or 
 # directories that contain example code fragments that are included (see 
index 1bb20b3..40fbc84 100644 (file)
--- a/filter.c
+++ b/filter.c
 #include "stdout.h"
 #include "error.h"
 
+/** init the array of errors for para_filter */
 INIT_FILTER_ERRLISTS;
 
+/** the task that reads from stdin */
 static struct stdin_task stdin_task_struct;
+/** pointer to the stdin task */
 static struct stdin_task *sit = &stdin_task_struct;
+
+/** the task that filters the data */
 static struct filter_chain filter_chain_struct;
+/** pointer to the filter chain */
 static struct filter_chain *fc = &filter_chain_struct;
+
+/** the task that writes converted data to stdout */
 static struct stdout_task stdout_task_struct;
+/** pointer to the stdout task */
 static struct stdout_task *sot = &stdout_task_struct;
 
+/** gengetopt struct that holds the command line args */
 static struct filter_args_info conf;
 
+
+/**
+ * standard log function that always writes to stderr
+ *
+ * \param ll loglevel. If the loglevel of the current message
+ * is less than \a ll, the message is going to be ignored.
+ *
+ * \param fmt the format string describing the log message.
+ *
+ */
 __printf_2_3 void para_log(int ll, const char* fmt,...)
 {
        va_list argp;
@@ -134,6 +154,18 @@ static int parse_config(int argc, char *argv[])
        exit(EXIT_SUCCESS);
 }
 
+/**
+ * para_filter's main function.
+ *
+ * para_filter reads data from stdin, converts it by using a chain
+ * of filters (specified on the command line) and writes the resulting
+ * data to stdout.
+ *
+ * \param argc number of command line options
+ * \param argv vector of arguments
+ *
+ * \return \a EXIT_SUCCESS on success, EXIT_FAILURE on errors.
+ */
 int main(int argc, char *argv[])
 {
        int ret;