document the LaTeX class a bit

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@16178 a592a061-630c-0410-9148-cb99ea01b6c8
This commit is contained in:
Georg Baum 2006-12-04 17:56:51 +00:00
parent 50380866f6
commit 0c9756da86

View 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)