Point fix, earlier forgotten

[lyx.git] / src / Chktex.h

diff --git a/src/Chktex.h b/src/Chktex.h
index 5fde42666c018948a3adb1450ff4e9a169c4193b..a73478974f52c9126f1d7fa88db32bfb5829ffac 100644 (file)
--- a/src/Chktex.h
+++ b/src/Chktex.h
@@ -1,24 +1,16 @@
 // -*- 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 (C) 1995 Matthias Ettrich
- *           Copyright (C) 1995-1998 The LyX Team.
+ * \author Asger Alstrup
  *
- *           This file is Copyright (C) 1997
- *           Asger Alstrup
- *
- *======================================================
+ * Full author contact details are available in file CREDITS.
  */
 
-#ifndef _CHKTEX_H
-#define _CHKTEX_H
-
-#ifdef __GNUG__
-#pragma interface
-#endif
+#ifndef CHKTEX_H
+#define CHKTEX_H
 
 #include "LString.h"
 
@@ -29,14 +21,15 @@ class TeXErrors;
 class Chktex {
 public:
        /**
-         cmd = the chktex command, file = name of the (temporary) latex file,
-         path = name of the files original path.
-         */
-       Chktex(LString const & cmd, LString const & file,
-              LString const & 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:
@@ -44,13 +37,13 @@ private:
        int scanLogFile(TeXErrors &);
 
        ///
-       LString cmd;
+       string cmd;
 
        ///
-       LString file;
-       
+       string file;
+
        ///
-       LString path;
+       string path;
 };
 
 #endif