From 95a8cd2aaa84f101a93a83a13871bfd1897fd7d3 Mon Sep 17 00:00:00 2001 From: Jean-Francois Dockes Date: Fri, 24 Apr 2015 09:56:24 +0200 Subject: [PATCH] comments --- src/common/rclconfig.h | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/src/common/rclconfig.h b/src/common/rclconfig.h index afcd0cf6..6e470517 100644 --- a/src/common/rclconfig.h +++ b/src/common/rclconfig.h @@ -287,8 +287,19 @@ class RclConfig { bool getMissingHelperDesc(string&) const; void storeMissingHelperDesc(const string &s); - /** Find exec file for external filter. cmd is the command name from the - * command string returned by getMimeHandlerDef */ + /** Find exec file for external filter. + * + * If the input is an absolute path, we just return it. Else We + * look in $RECOLL_FILTERSDIR, "filtersdir" from the config file, + * $RECOLL_CONFDIR/. If nothing is found, we return the input with + * the assumption that this will be used with a PATH-searching + * exec. + * + * @param cmd is normally the command name from the command string + * returned by getMimeHandlerDef(), but this could be used for any + * command. If cmd begins with a /, we return cmd without + * further processing. + */ string findFilter(const string& cmd) const; /** Thread config init is not done automatically because not all