X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FChktex.h;h=5ad8af2ccaf0d806ae150fd34adff26de36c4106;hb=29f01faa17495e3d80c08f234c8f049c7d699ac1;hp=3770d0f1f93f10b8334b6b368418c4dec7860dfe;hpb=9ce32d63e5ff1dbf4c04e3d8263b2649ef3ac595;p=lyx.git diff --git a/src/Chktex.h b/src/Chktex.h index 3770d0f1f9..5ad8af2cca 100644 --- a/src/Chktex.h +++ b/src/Chktex.h @@ -1,16 +1,16 @@ // -*- C++ -*- /* This file is part of - * ====================================================== - * + * ====================================================== + * * LyX, The Document Processor * * Copyright 1995 Matthias Ettrich - * Copyright 1995-2000 The LyX Team. + * Copyright 1995-2001 The LyX Team. * * This file is Copyright 1997 * Asger Alstrup * - * ====================================================== + * ====================================================== */ #ifndef CHKTEX_H @@ -29,14 +29,15 @@ class TeXErrors; class Chktex { public: /** - cmd = the chktex command, file = name of the (temporary) latex file, - path = name of the files original path. - */ + @param cmd the chktex command. + @param file name of the (temporary) latex file. + @param path name of the files original path. + */ Chktex(string const & cmd, string const & file, string const & path); - + /** Runs chktex. - Returns -1 if fail, number of messages otherwise. + @return -1 if fail, number of messages otherwise. */ int run(TeXErrors &); private: @@ -48,7 +49,7 @@ private: /// string file; - + /// string path; };