doxygen: fixed warning messages
This commit is contained in:
parent
c5e0104ab8
commit
e4a45aefe2
|
@ -32,7 +32,7 @@ class Token;
|
|||
|
||||
|
||||
/**
|
||||
* @brief @Check exception safety (exceptions shouldn't cause leaks nor corrupt data)
|
||||
* @brief %Check exception safety (exceptions shouldn't cause leaks nor corrupt data)
|
||||
*
|
||||
* The problem with these checks is that Cppcheck can't determine what the valid
|
||||
* values are for variables. But in some cases (dead pointers) it can be determined
|
||||
|
|
|
@ -24,7 +24,9 @@
|
|||
//---------------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* \file Check for memory leaks
|
||||
* @file
|
||||
*
|
||||
* %Check for memory leaks
|
||||
*
|
||||
* The checking is split up into two specialized classes.
|
||||
* - CheckMemoryLeakInFunction can detect when a function variable is allocated but not deallocated properly.
|
||||
|
@ -152,7 +154,7 @@ public:
|
|||
|
||||
|
||||
/**
|
||||
* @brief @CheckMemoryLeakInFunction detects when a function variable is allocated but not deallocated properly.
|
||||
* @brief %CheckMemoryLeakInFunction detects when a function variable is allocated but not deallocated properly.
|
||||
*
|
||||
* The checking is done by looking at each function variable separately. By repeating these 4 steps over and over:
|
||||
* -# locate a function variable
|
||||
|
@ -194,21 +196,21 @@ private:
|
|||
#endif
|
||||
|
||||
/**
|
||||
* @brief @Check all variables in function scope
|
||||
* @brief %Check all variables in function scope
|
||||
* @param tok The first '{' token of the function scope
|
||||
* @param classmember Is this function a class member?
|
||||
*/
|
||||
void parseFunctionScope(const Token *tok, const bool classmember);
|
||||
|
||||
/**
|
||||
* @brief @Check if there is a "p = foo(p, .." and foo returns the argument (p)
|
||||
* @brief %Check if there is a "p = foo(p, .." and foo returns the argument (p)
|
||||
* @param tok token to the ";" before the statement
|
||||
* @param varid varid to check
|
||||
*/
|
||||
bool matchFunctionsThatReturnArg(const Token *tok, unsigned int varid) const;
|
||||
|
||||
/**
|
||||
* @brief @Check if there is a "!var" match inside a condition
|
||||
* @brief %Check if there is a "!var" match inside a condition
|
||||
* @param tok first token to match
|
||||
* @param varid variabla id
|
||||
* @param endpar if this is true the "!var" must be followed by ")"
|
||||
|
|
|
@ -1620,7 +1620,7 @@ public:
|
|||
|
||||
|
||||
/**
|
||||
* Skip string in line. A string begins and ends with either a " or a '
|
||||
* Skip string in line. A string begins and ends with either a " or a '
|
||||
* @param line the string
|
||||
* @param pos in=start position of string, out=end position of string
|
||||
*/
|
||||
|
|
|
@ -112,7 +112,7 @@ protected:
|
|||
static std::string replaceIfDefined(const std::string &str);
|
||||
|
||||
/**
|
||||
* expand macros in code. #ifdefs etc are ignored so the code must be a single configuration
|
||||
* expand macros in code. ifdefs etc are ignored so the code must be a single configuration
|
||||
* @param code The input code
|
||||
* @param filename filename of source file
|
||||
* @param errorLogger Error logger to write errors to (if any)
|
||||
|
|
|
@ -143,7 +143,7 @@ public:
|
|||
/**
|
||||
* Don't show this error. If file and/or line are optional. In which case
|
||||
* the errorId alone is used for filtering.
|
||||
* @param errorId, the id for the error, e.g. "arrayIndexOutOfBounds"
|
||||
* @param errorId the id for the error, e.g. "arrayIndexOutOfBounds"
|
||||
* @param file File name with the path, e.g. "src/main.cpp"
|
||||
* @param line number, e.g. "123"
|
||||
*/
|
||||
|
|
39
lib/token.h
39
lib/token.h
|
@ -96,19 +96,19 @@ public:
|
|||
* Match given token (or list of tokens) to a pattern list.
|
||||
*
|
||||
* Possible patterns
|
||||
* "%any%" any token
|
||||
* "%var%" any token which is a name or type e.g. "hello" or "int"
|
||||
* "%name%" any token which is a name or type e.g. "hello" or "int"
|
||||
* "%type%" Anything that can be a variable type, e.g. "int", but not "delete".
|
||||
* "%num%" Any numeric token, e.g. "23"
|
||||
* "%bool%" true or false
|
||||
* "%str%" Any token starting with "-character (C-string).
|
||||
* "%varid%" Match with parameter varid
|
||||
* "[abc]" Any of the characters 'a' or 'b' or 'c'
|
||||
* "int|void|char" Any of the strings, int, void or char
|
||||
* "int|void|char|" Any of the strings, int, void or char or empty string
|
||||
* "!!else" No tokens or any token that is not "else".
|
||||
* "someRandomText" If token contains "someRandomText".
|
||||
* - "%any%" any token
|
||||
* - "%var%" any token which is a name or type e.g. "hello" or "int"
|
||||
* - "%name%" any token which is a name or type e.g. "hello" or "int"
|
||||
* - "%type%" Anything that can be a variable type, e.g. "int", but not "delete".
|
||||
* - "%num%" Any numeric token, e.g. "23"
|
||||
* - "%bool%" true or false
|
||||
* - "%str%" Any token starting with "-character (C-string).
|
||||
* - "%varid%" Match with parameter varid
|
||||
* - "[abc]" Any of the characters 'a' or 'b' or 'c'
|
||||
* - "int|void|char" Any of the strings, int, void or char
|
||||
* - "int|void|char|" Any of the strings, int, void or char or empty string
|
||||
* - "!!else" No tokens or any token that is not "else".
|
||||
* - "someRandomText" If token contains "someRandomText".
|
||||
*
|
||||
* The patterns can be also combined to compare to multiple tokens at once
|
||||
* by separating tokens with a space, e.g.
|
||||
|
@ -119,6 +119,7 @@ public:
|
|||
* @param tok List of tokens to be compared to the pattern
|
||||
* @param pattern The pattern against which the tokens are compared,
|
||||
* e.g. "const" or ") const|volatile| {".
|
||||
* @param varid if %varid% is given in the pattern the Token::varId will be matched against this argument
|
||||
* @return true if given token matches with given pattern
|
||||
* false if given token does not match with given pattern
|
||||
*/
|
||||
|
@ -313,22 +314,22 @@ private:
|
|||
|
||||
/**
|
||||
* Works almost like strcmp() except returns only 0 or 1 and
|
||||
* if str has empty space ' ' character, that character is handled
|
||||
* as if it were '\0'
|
||||
* if str has empty space ' ' character, that character is handled
|
||||
* as if it were '\\0'
|
||||
*/
|
||||
static int firstWordEquals(const char *str, const char *word);
|
||||
|
||||
/**
|
||||
* Works almost like strchr() except
|
||||
* if str has empty space ' ' character, that character is handled
|
||||
* as if it were '\0'
|
||||
* if str has empty space ' ' character, that character is handled
|
||||
* as if it were '\\0'
|
||||
*/
|
||||
static const char *chrInFirstWord(const char *str, char c);
|
||||
|
||||
/**
|
||||
* Works almost like strlen() except
|
||||
* if str has empty space ' ' character, that character is handled
|
||||
* as if it were '\0'
|
||||
* if str has empty space ' ' character, that character is handled
|
||||
* as if it were '\\0'
|
||||
*/
|
||||
static int firstWordLen(const char *str);
|
||||
|
||||
|
|
Loading…
Reference in New Issue