X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FChktex.h;h=34826bbcea65668e2563b796980106b645b32c92;hb=3826ff643433ad166c3402b146b3860ab5d6861e;hp=f45d14d82e8b2edc0f0808228de1ae77d2bdf5d7;hpb=0eccdd1c3613e5170deb77b22174dd0afde833e9;p=lyx.git diff --git a/src/Chktex.h b/src/Chktex.h index f45d14d82e..34826bbcea 100644 --- a/src/Chktex.h +++ b/src/Chktex.h @@ -1,56 +1,52 @@ // -*- C++ -*- -/* This file is part of - * ====================================================== - * - * LyX, The Document Processor +/** + * \file Chktex.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * Copyright 1995 Matthias Ettrich - * Copyright 1995-1999 The LyX Team. + * \author Asger Alstrup * - * This file is Copyright 1997 - * Asger Alstrup - * - * ====================================================== + * Full author contact details are available in file CREDITS. */ #ifndef CHKTEX_H #define CHKTEX_H -#ifdef __GNUG__ -#pragma interface -#endif +#include + -#include "LString.h" +namespace lyx { -class LyXLex; class TeXErrors; + /// class Chktex { public: /** - cmd = the chktex command, file = name of the (temporary) latex file, - path = name of the files original path. - */ - Chktex(string const & cmd, string const & file, - string const & path); - + @param cmd the chktex command. + @param file name of the (temporary) latex file. + @param path name of the files original path. + */ + Chktex(std::string const & cmd, std::string const & file, + std::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: /// int scanLogFile(TeXErrors &); - /// - string cmd; - + std::string cmd; /// - string file; - + std::string file; /// - string path; + std::string path; }; + +} // namespace lyx + #endif