Fix documentation of check_filter_arg().
authorAndre Noll <maan@tuebingen.mpg.de>
Sun, 24 Jul 2016 09:50:32 +0000 (11:50 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Sun, 31 Jul 2016 14:54:52 +0000 (16:54 +0200)
Filter name and filter options are separated by whitespace rather
than a colon as stated in the documentation.

filter_common.c

index 6fb9bd9..20eb02f 100644 (file)
@@ -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.