]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeX.h
* GuiView.C (updateTab): do not update early if current tab has
[lyx.git] / src / LaTeX.h
index 69845478b1103ce1e97a9fe696808a3c97a33702..bc310ec1db5d6d1d493f86d086e121d371365c67 100644 (file)
@@ -86,7 +86,13 @@ bool operator==(Aux_Info const &, Aux_Info const &);
 bool operator!=(Aux_Info const &, Aux_Info const &);
 
 
-///
+/**
+ * Class to run the LaTeX compiler and needed auxiliary programs.
+ * The main .tex file must be in the current directory. The current directory
+ * must not change as long as an object of this class lives.
+ * This is required by the LaTeX compiler, and we also make use of it by
+ * various support::makeAbsPath() calls.
+ */
 class LaTeX : boost::noncopyable {
 public:
        /** Return values from scanLogFile() and run() (to come)