Add some documentation for findtexfile

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@16632 a592a061-630c-0410-9148-cb99ea01b6c8

diff --git a/src/support/filetools.h b/src/support/filetools.h
index 7de0b67a5642385425e5b3a1ab4ed9cefca30eed..3def1d77e34ec775dbbac18dae3b19a55bb37757 100644 (file)
--- a/src/support/filetools.h
+++ b/src/support/filetools.h
@@ -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);