From: Georg Baum <Georg.Baum@post.rwth-aachen.de>
Date: Tue, 9 Jan 2007 19:10:29 +0000 (+0000)
Subject: Add some documentation for findtexfile
X-Git-Tag: 1.6.10~11241
X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=6ca4bd03e0dffa3780fdbe16281d587214bc4862;p=lyx.git

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 7de0b67a56..3def1d77e3 100644
--- 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);