Add a meaningful description of what LibScriptSearch now does.

[lyx.git] / src / support / filetools.h

diff --git a/src/support/filetools.h b/src/support/filetools.h
index 21e09e47d6e2d3314be943189a3557e56a20c005..7baca7d90d36aa1c4ba69988bd1727db0695e29a 100644 (file)
--- a/src/support/filetools.h
+++ b/src/support/filetools.h
@@ -93,10 +93,12 @@ string const
 i18nLibFileSearch(string const & dir, string const & name,
                  string const & ext = string());
 
-/** Takes a command with arguments as input and tries to see whether
-  the command itself can be found in one of the scripts/ directories.
-  If it is found, return the command with fully qualified script name,
-  either return it unchanged */
+/** Takes a command such as "sh $$s/convertDefault.sh file.in file.out"
+ *  and replaces "$$s/" with the path to the "most important" of LyX's
+ *  script directories containing this script. If the script is not found,
+ *  "$$s/" is removed. Executing the command will still fail, but the
+ *  error message will make some sort of sense ;-)
+ */
 string const LibScriptSearch(string const & command);
 
 ///