From: Andre Noll <maan@tuebingen.mpg.de>
Date: Sun, 24 Jul 2016 09:50:32 +0000 (+0200)
Subject: Fix documentation of check_filter_arg().
X-Git-Tag: v0.5.7~39
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=224ab3f14af8e08a8a7159160eccea75be30ffd1

Fix documentation of check_filter_arg().

Filter name and filter options are separated by whitespace rather
than a colon as stated in the documentation.
---

diff --git a/filter_common.c b/filter_common.c
index 6fb9bd96..20eb02f5 100644
--- a/filter_common.c
+++ b/filter_common.c
@@ -78,11 +78,12 @@ static int parse_filter_args(int filter_num, char *options, void **conf)
 /**
  * Check the filter command line options.
  *
- * \param fa The command line options.
+ * \param fa The filter argument.
  * \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.
+ * Check if the given filter argument starts with the name of a supported
+ * filter, optionally followed by options for this filter. If yes, call the
+ * command line parser of that filter.
  *
  * \return On success, the number of the filter is returned and \a conf
  * is initialized to point to the filter configuration determined by \a fa.