Refactoring: Added missing license texts and some comments

cppcheck.h

@@ -83,8 +83,21 @@ class CppCheck : public ErrorLogger
 
     private:
         void checkFile(const std::string &code, const char FileName[]);
+
+        /**
+         * Errors and warnings are directed here.
+         *
+         * @param errmsg Errors messages are normally in format
+         * "[filepath:line number] Message", e.g.
+         * "[main.cpp:4] Uninitialized member variable"
+         */
         virtual void reportErr( const std::string &errmsg);
-        //void reportErr( const TOKEN *token, const std::string &errmsg);
+
+        /**
+         * Information about progress is directed here.
+         *
+         * @param outmsg, E.g. "Checking main.cpp..."
+         */
         virtual void reportOut( const std::string &outmsg);
 
         std::list<std::string> _errorList;

cppcheckexecutor.cpp

@@ -1,3 +1,21 @@
+/*
+ * c++check - c/c++ syntax checking
+ * Copyright (C) 2007-2008 Daniel Marjamäki and Reijo Tomperi
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/
+ */
+
 #include "cppcheckexecutor.h"
 #include "cppcheck.h"
 #include <iostream>

cppcheckexecutor.h

@@ -1,18 +1,71 @@
+/*
+ * c++check - c/c++ syntax checking
+ * Copyright (C) 2007-2008 Daniel Marjamäki and Reijo Tomperi
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/
+ */
+
 #ifndef CPPCHECKEXECUTOR_H
 #define CPPCHECKEXECUTOR_H
 
 #include "errorlogger.h"
 
+/**
+ * This class works as an example of how CppCheck can be used in external
+ * programs without very little knowledge of the internal parts of the
+ * program itself. If you wish to use cppcheck e.g. as a part of IDE,
+ * just rewrite this class for your needs and possibly use other methods
+ * from CppCheck class instead the ones used here.
+ */
 class CppCheckExecutor : public ErrorLogger
 {
-    public:
+public:
-        CppCheckExecutor();
+    /**
-        virtual ~CppCheckExecutor();
+     * Constructor
-        void check( int argc, char* argv[] );
+     */
-        void reportErr( const std::string &errmsg);
+    CppCheckExecutor();
-        void reportOut( const std::string &outmsg);
+
-    protected:
+    /**
-    private:
+     * Destructor
+     */
+    virtual ~CppCheckExecutor();
+
+    /**
+     * Starts the checking.
+     *
+     * @param argc from main()
+     * @param argv from main()
+     */
+    void check( int argc, char* argv[] );
+
+    /**
+     * Errors and warnings are directed here. This should be
+     * called by the CppCheck class only.
+     *
+     * @param errmsg Errors messages are normally in format
+     * "[filepath:line number] Message", e.g.
+     * "[main.cpp:4] Uninitialized member variable"
+     */
+    virtual void reportErr( const std::string &errmsg);
+
+    /**
+     * Information about progress is directed here. This should be
+     * called by the CppCheck class only.
+     *
+     * @param outmsg, E.g. "Checking main.cpp..."
+     */
+    virtual void reportOut( const std::string &outmsg);
 };
 
 #endif // CPPCHECKEXECUTOR_H

errorlogger.h

@@ -28,7 +28,20 @@
 class ErrorLogger
 {
 public:
+    /**
+     * Errors and warnings are directed here.
+     *
+     * @param errmsg Errors messages are normally in format
+     * "[filepath:line number] Message", e.g.
+     * "[main.cpp:4] Uninitialized member variable"
+     */
     virtual void reportErr( const std::string &errmsg) = 0;
+
+    /**
+     * Information about progress is directed here.
+     *
+     * @param outmsg, E.g. "Checking main.cpp..."
+     */
     virtual void reportOut( const std::string &outmsg) = 0;
 };