Fix couple of doxygen errors and warnings.
This commit is contained in:
parent
b4c3ed78b4
commit
180a04316d
|
@ -55,13 +55,11 @@ public:
|
||||||
*/
|
*/
|
||||||
int check(int argc, const char* const argv[]);
|
int check(int argc, const char* const argv[]);
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Information about progress is directed here. This should be
|
* Information about progress is directed here. This should be
|
||||||
* called by the CppCheck class only.
|
* 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);
|
virtual void reportOut(const std::string &outmsg);
|
||||||
|
|
||||||
|
|
|
@ -98,12 +98,12 @@ protected:
|
||||||
static std::string removeComments(const std::string &str);
|
static std::string removeComments(const std::string &str);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the string between double quote characters or < > characters.
|
* Returns the string between double quote characters or \< \> characters.
|
||||||
* @param str e.g. '#include "menu.h"' or '#include <menu.h>'
|
* @param str e.g. \code#include "menu.h"\endcode or \code#include <menu.h>\endcode
|
||||||
* After function call it will contain e.g. "menu.h" without double quotes.
|
* 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
|
* 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);
|
static int getHeaderFileName(std::string &str);
|
||||||
private:
|
private:
|
||||||
|
|
|
@ -48,6 +48,7 @@ public:
|
||||||
/**
|
/**
|
||||||
* Tokenize code
|
* Tokenize code
|
||||||
* @param code input stream for code, e.g.
|
* @param code input stream for code, e.g.
|
||||||
|
* \code
|
||||||
* #file "p.h"
|
* #file "p.h"
|
||||||
* class Foo
|
* class Foo
|
||||||
* {
|
* {
|
||||||
|
@ -59,6 +60,7 @@ public:
|
||||||
* void Foo::Bar()
|
* void Foo::Bar()
|
||||||
* {
|
* {
|
||||||
* }
|
* }
|
||||||
|
* \endcode
|
||||||
*
|
*
|
||||||
* @param FileName The filename
|
* @param FileName The filename
|
||||||
* @return false if Source code contains syntax errors
|
* @return false if Source code contains syntax errors
|
||||||
|
|
Loading…
Reference in New Issue