From: Andre Noll <maan@systemlinux.org>
Date: Sun, 20 Apr 2008 18:58:40 +0000 (+0200)
Subject: filter.c: Cosmetics.
X-Git-Tag: v0.3.3~63
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=95d73238eeffa417a997f042fe9c40a13ced3906;p=paraslash.git

filter.c: Cosmetics.
---

diff --git a/filter.c b/filter.c
index 16204393..939f9b56 100644
--- a/filter.c
+++ b/filter.c
@@ -3,7 +3,8 @@
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
-/** \file filter.c the stand-alone filter program */
+
+/** \file filter.c The stand-alone filter program. */
 
 #include "para.h"
 
@@ -16,25 +17,25 @@
 #include "stdout.h"
 #include "error.h"
 
-/** init the array of errors for para_filter */
+/** Initialize the array of errors for para_filter. */
 INIT_FILTER_ERRLISTS;
 
-/** the task that reads from stdin */
+/** The task that reads from stdin. */
 static struct stdin_task stdin_task_struct;
-/** pointer to the stdin task */
+/** pointer to the stdin task. */
 static struct stdin_task *sit = &stdin_task_struct;
 
-/** the task that filters the data */
+/** The task that filters the data. */
 static struct filter_chain filter_chain_struct;
-/** pointer to the filter chain */
+/** Pointer to the filter chain. */
 static struct filter_chain *fc = &filter_chain_struct;
 
-/** the task that writes converted data to stdout */
+/** The task that writes converted data to stdout. */
 static struct stdout_task stdout_task_struct;
-/** pointer to the stdout task */
+/** Pointer to the stdout task. */
 static struct stdout_task *sot = &stdout_task_struct;
 
-/** gengetopt struct that holds the command line args */
+/** Gengetopt struct that holds the command line args. */
 static struct filter_args_info conf;
 
 INIT_STDERR_LOGGING(conf.loglevel_arg);
@@ -124,14 +125,14 @@ static int parse_config(int argc, char *argv[])
 }
 
 /**
- * para_filter's main function.
+ * The main function of para_filter.
  *
- * para_filter reads data from stdin, converts it by using a chain
+ * 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
+ * \param argc Number of command line options.
+ * \param argv Vector of arguments.
  *
  * \return \a EXIT_SUCCESS on success, EXIT_FAILURE on errors.
  */