doxygen: fixed error messages

This commit is contained in:
Daniel Marjamäki 2010-03-14 07:48:44 +01:00
parent e4a45aefe2
commit 7bcb7897e4
3 changed files with 7 additions and 3 deletions

View File

@ -1397,7 +1397,9 @@ private:
void operator=(const PreprocessorMacro &);
public:
/**
* @param macro The code after #define, until end of line,
* @brief Constructor for PreprocessorMacro. This is the "setter"
* for this class - everything is setup here.
* @param macro The code after define, until end of line,
* e.g. "A(x) foo(x);"
*/
PreprocessorMacro(const std::string &macro)

View File

@ -123,6 +123,8 @@ protected:
/**
* Remove comments from code. This should only be called from read().
* @param str Code processed by read().
* @param filename filename
* @param settings Settings. If there are inline suppressions these will be added to the settings
* @return code without comments
* @throws std::runtime_error when code contains unhandled characters
*/

View File

@ -150,8 +150,8 @@ public:
void addSuppression(const std::string &errorId, const std::string &file = "", unsigned int line = 0);
/**
* Returns true if this message should not be shown to the user.
* @param errorId, the id for the error, e.g. "arrayIndexOutOfBounds"
* @brief Returns true if this message should not be shown to the user.
* @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"
* @return true if this error is suppressed.