Fix documentation of check_filter_arg().

[paraslash.git] / filter_common.c

diff --git a/filter_common.c b/filter_common.c
index 6fb9bd96ef8278b3e328198e24db78664a956542..20eb02f55ee9c553a49a2c174e69c703a391e797 100644 (file)
--- 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.