doxygen updates

This commit is contained in:
Daniel Marjamäki 2010-03-17 22:16:18 +01:00
parent 89719b023e
commit e911d1f1df
11 changed files with 24 additions and 24 deletions

View File

@ -45,7 +45,7 @@ public:
instances().sort(); instances().sort();
} }
/** This constructor is used when running checks.. */ /** This constructor is used when running checks. */
Check(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger) Check(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger)
: _tokenizer(tokenizer), _settings(settings), _errorLogger(errorLogger) : _tokenizer(tokenizer), _settings(settings), _errorLogger(errorLogger)
{ } { }

View File

@ -37,7 +37,7 @@ public:
CheckAutoVariables() : Check() CheckAutoVariables() : Check()
{ } { }
/** This constructor is used when running checks.. */ /** This constructor is used when running checks. */
CheckAutoVariables(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger) CheckAutoVariables(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger)
: Check(tokenizer, settings, errorLogger) : Check(tokenizer, settings, errorLogger)
{ } { }

View File

@ -52,7 +52,7 @@ public:
CheckBufferOverrun() : Check() CheckBufferOverrun() : Check()
{ } { }
/** This constructor is used when running checks.. */ /** This constructor is used when running checks. */
CheckBufferOverrun(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger) CheckBufferOverrun(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger)
: Check(tokenizer, settings, errorLogger) : Check(tokenizer, settings, errorLogger)
{ } { }

View File

@ -38,7 +38,7 @@ public:
CheckClass() : Check() CheckClass() : Check()
{ } { }
/** @brief This constructor is used when running checks.. */ /** @brief This constructor is used when running checks. */
CheckClass(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger) CheckClass(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger)
: Check(tokenizer, settings, errorLogger) : Check(tokenizer, settings, errorLogger)
{ } { }
@ -90,7 +90,7 @@ public:
*/ */
void noMemset(); void noMemset();
/** @brief 'operator=' should return something.. */ /** @brief 'operator=' should return something. */
void operatorEq(); void operatorEq();
/** @brief 'operator=' should return reference to *this */ /** @brief 'operator=' should return reference to *this */

View File

@ -38,7 +38,7 @@ public:
CheckDangerousFunctions() : Check() CheckDangerousFunctions() : Check()
{ } { }
/** This constructor is used when running checks.. */ /** This constructor is used when running checks. */
CheckDangerousFunctions(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger) CheckDangerousFunctions(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger)
: Check(tokenizer, settings, errorLogger) : Check(tokenizer, settings, errorLogger)
{ } { }

View File

@ -46,7 +46,7 @@ public:
CheckExceptionSafety() : Check() CheckExceptionSafety() : Check()
{ } { }
/** This constructor is used when running checks.. */ /** This constructor is used when running checks. */
CheckExceptionSafety(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger) CheckExceptionSafety(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger)
: Check(tokenizer, settings, errorLogger) : Check(tokenizer, settings, errorLogger)
{ } { }

View File

@ -1741,7 +1741,7 @@ private:
} }
/** Initialize an array with strncpy.. */ /** Initialize an array with strncpy. */
static void init_strncpy(std::list<ExecutionPath *> &checks, const Token *tok) static void init_strncpy(std::list<ExecutionPath *> &checks, const Token *tok)
{ {
const unsigned int varid(tok->varId()); const unsigned int varid(tok->varId());

View File

@ -40,7 +40,7 @@ public:
CheckOther() : Check() CheckOther() : Check()
{ } { }
/** @brief This constructor is used when running checks.. */ /** @brief This constructor is used when running checks. */
CheckOther(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger) CheckOther(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger)
: Check(tokenizer, settings, errorLogger) : Check(tokenizer, settings, errorLogger)
{ } { }

View File

@ -38,7 +38,7 @@ public:
CheckStl() : Check() CheckStl() : Check()
{ } { }
/** This constructor is used when running checks.. */ /** This constructor is used when running checks. */
CheckStl(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger) CheckStl(const Tokenizer *tokenizer, const Settings *settings, ErrorLogger *errorLogger)
: Check(tokenizer, settings, errorLogger) : Check(tokenizer, settings, errorLogger)
{ } { }

View File

@ -1281,7 +1281,7 @@ bool Tokenizer::tokenize(std::istream &code, const char FileName[], const std::s
} }
//--------------------------------------------------------------------------- //---------------------------------------------------------------------------
/** Specify array size if it hasn't been given.. */ /** Specify array size if it hasn't been given */
void Tokenizer::arraySize() void Tokenizer::arraySize()
{ {
@ -1335,7 +1335,7 @@ void Tokenizer::labels()
/** /**
* is the token pointing at a template parameters block.. * is the token pointing at a template parameters block
* < int , 3 > => yes * < int , 3 > => yes
* \param tok start token that must point at "<" * \param tok start token that must point at "<"
* \return true if the tokens look like template parameters * \return true if the tokens look like template parameters

View File

@ -38,7 +38,7 @@ class Settings;
class Tokenizer class Tokenizer
{ {
private: private:
/** Deallocate lists.. */ /** Deallocate lists */
void deallocateTokens(); void deallocateTokens();
public: public:
@ -179,40 +179,40 @@ public:
bool simplifyQuestionMark(); bool simplifyQuestionMark();
/** /**
* simplify if-assignments.. * simplify if-assignments
* Example: "if(a=b);" => "a=b;if(a);" * Example: "if(a=b);" => "a=b;if(a);"
*/ */
void simplifyIfAssign(); void simplifyIfAssign();
/** /**
* simplify if-not.. * simplify if-not
* Example: "if(0==x);" => "if(!x);" * Example: "if(0==x);" => "if(!x);"
*/ */
void simplifyIfNot(); void simplifyIfNot();
/** /**
* simplify if-not NULL.. * simplify if-not NULL
* Example: "if(0!=x);" => "if(x);" * - "if(0!=x);" => "if(x);"
*/ */
void simplifyIfNotNull(); void simplifyIfNotNull();
/** @brief simplify if (a) { if (a) .. */ /** @brief simplify if (a) { if (a) */
void simplifyIfSameInnerCondition(); void simplifyIfSameInnerCondition();
/** /**
* Simplify the "not" and "and" keywords to "!" and "&&" * Simplify the "not" and "and" keywords to "!" and "&&"
* accordingly. * accordingly.
* Examples: * Examples:
* "if (not p)" => "if (!p)" * - "if (not p)" => "if (!p)"
* "if (p and q)" => "if (p && q)" * - "if (p and q)" => "if (p && q)"
*/ */
void simplifyLogicalOperators(); void simplifyLogicalOperators();
/** /**
* Simplify comma into a semicolon when possible * Simplify comma into a semicolon when possible:
* Example: "delete a, delete b" => "delete a; delete b;" * - "delete a, delete b" => "delete a; delete b;"
* Example: "a = 0, b = 0;" => "a = 0; b = 0;" * - "a = 0, b = 0;" => "a = 0; b = 0;"
* Example: "return a(), b;" => "a(); return b;" * - "return a(), b;" => "a(); return b;"
*/ */
void simplifyComma(); void simplifyComma();