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 35f4badfc91f04c013e64bb7a9d76431e451f24b..7baca7d90d36aa1c4ba69988bd1727db0695e29a 100644 (file)
--- a/src/support/filetools.h
+++ b/src/support/filetools.h
@@ -13,21 +13,18 @@
 #include "LString.h"
 
 
+/// remove directory and all contents, returns 0 on success
+int destroyDir(string const & tmpdir);
+
 ///
 string const CreateBufferTmpDir(string const & pathfor = string());
 
-/// Creates directory. Returns true on succes.
+/// Creates directory. Returns true on success
 bool createDirectory(string const & name, int permissions);
 
 ///
 string const CreateLyXTmpDir(string const & deflt);
 
-///
-int DestroyBufferTmpDir(string const & tmpdir);
-
-///
-int DestroyLyXTmpDir(string const & tmpdir);
-
 /** Find file by searching several directories.
   Uses a string of paths separated by ";"s to find a file to open.
     Can't cope with pathnames with a ';' in them. Returns full path to file.
@@ -96,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);
 
 ///