diff --git a/src/cppcheckexecutor.h b/src/cppcheckexecutor.h index bf89266b8..23e6e7402 100644 --- a/src/cppcheckexecutor.h +++ b/src/cppcheckexecutor.h @@ -55,13 +55,11 @@ public: */ int check(int argc, const char* const argv[]); - - /** * Information about progress is directed here. This should be * called by the CppCheck class only. * - * @param outmsg, E.g. "Checking main.cpp..." + * @param outmsg Progress message e.g. "Checking main.cpp..." */ virtual void reportOut(const std::string &outmsg); diff --git a/src/preprocessor.h b/src/preprocessor.h index c129dff7b..0fdbffb17 100644 --- a/src/preprocessor.h +++ b/src/preprocessor.h @@ -98,12 +98,12 @@ protected: static std::string removeComments(const std::string &str); /** - * Returns the string between double quote characters or < > characters. - * @param str e.g. '#include "menu.h"' or '#include ' + * Returns the string between double quote characters or \< \> characters. + * @param str e.g. \code#include "menu.h"\endcode or \code#include \endcode * After function call it will contain e.g. "menu.h" without double quotes. - * @return 0 empty string if double quotes or < > were not found. + * @return 0 empty string if double quotes or \< \> were not found. * 1 if file surrounded with "" was found - * 2 if file surrounded with <> was found + * 2 if file surrounded with \<\> was found */ static int getHeaderFileName(std::string &str); private: diff --git a/src/tokenize.h b/src/tokenize.h index a4758bf21..e536961d0 100644 --- a/src/tokenize.h +++ b/src/tokenize.h @@ -48,6 +48,7 @@ public: /** * Tokenize code * @param code input stream for code, e.g. + * \code * #file "p.h" * class Foo * { @@ -59,6 +60,7 @@ public: * void Foo::Bar() * { * } + * \endcode * * @param FileName The filename * @return false if Source code contains syntax errors