make doc++ able to generate the source documentation for lyx

[features.git] / src / Chktex.h

diff --git a/src/Chktex.h b/src/Chktex.h
index 3770d0f1f93f10b8334b6b368418c4dec7860dfe..745e8b449317c8b1dddd1a5af833c084d9495fc9 100644 (file)
--- a/src/Chktex.h
+++ b/src/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: