]> git.lyx.org Git - lyx.git/blobdiff - src/support/filetools.h
final compilation: wheel was already invented :(
[lyx.git] / src / support / filetools.h
index 86abc47b4ad48046c59d327c27077acb77bf22c1..3def1d77e34ec775dbbac18dae3b19a55bb37757 100644 (file)
@@ -81,7 +81,7 @@ std::vector<FileName> const dirList(FileName const & dir,
     true: dir writeable
     false: not writeable
 */
-bool isDirWriteable(std::string const & path);
+bool isDirWriteable(FileName const & path);
 
 /** Is a file readable ?
   Returns true if the file `path' is readable.
@@ -236,7 +236,7 @@ std::string const expandPath(std::string const & path);
   If relpath is absolute, just use that.
   If basepath doesn't exist use CWD.
   */
-std::string const makeAbsPath(std::string const & RelPath = std::string(),
+FileName const makeAbsPath(std::string const & RelPath = std::string(),
                              std::string const & BasePath = std::string());
 
 /** Creates a nice compact path for displaying. The parameter
@@ -283,7 +283,14 @@ bool readLink(std::string const & file,
              std::string & link,
              bool resolve = false);
 
-/// Uses kpsewhich to find tex files
+/**
+ * Search a TeX file in all locations the latex compiler would search it,
+ * with the help of kpsewhich.
+ * The current working directory must be set correctly, so that relative
+ * names work.
+ * \param fil The filename to search
+ * \param format The file format as used by kpsewhich, e.g. "bib", "bst" etc.
+ */
 FileName const findtexfile(std::string const & fil,
                              std::string const & format);